fiber_bundle::chart_point Class Reference

A point in chart space. More...

#include <chart_point.h>

Inheritance diagram for fiber_bundle::chart_point:

CHART_POINT FACET
typedef chart_point_coord_type	coord_type
	The type of local coordinate; the scalar type for the local coordinate vector space. More...
pod_index_type	_chart_id
	The id of the chart this point is in. More...
static chart_point *	new_chart_point (int xdb)
	Factory method; creates a chart point with db() == xdb. More...
virtual	~chart_point ()
	Destructor. More...
pod_index_type	chart_id () const
	The id of the chart this point is in. More...
void	put_chart_id (pod_index_type xchart)
	Sets chart_id() to xchart_id. More...
void	put_chart_id (const scoped_index &xchart)
	Sets chart_id() to xchart_id.hub_pod(). More...
virtual int	db () const =0
	The dimension of this chart. More...
virtual coord_type	local_coord (int xi) const =0
	The xi-th local coordinate of this point. More...
virtual void	put_local_coord (int xi, coord_type xvalue)=0
	Sets the xi-th local coordinate of this point to xvalue. More...
virtual coord_type *	local_coords ()=0
	The array of local coordinates. More...
virtual const coord_type *	local_coords () const =0
	The array of local coordinates. More...
void	put_local_coords (const coord_type *xvalues, size_type xvalues_ub)
	Sets the local coordinates to the values in xvalues. More...
void	put_local_coords_zero ()
	Sets the local coordinates to the zero vector. More...
bool	is_valid () const
	True if this ia a valid point in a chart. More...
void	invalidate ()
	Makes this invalid. More...
	chart_point ()
	Default constructor. More...

ANY FACET
virtual chart_point *	clone () const =0
	Virtual constructor, makes a new instance of the same type as this. More...
virtual bool	invariant () const
	Class invariant. More...
virtual bool	is_ancestor_of (const any *other) const
	Conformance test; true if other conforms to this. More...
chart_point &	operator= (const chart_point &xother)
	Assignment operator. More...
bool	operator== (const chart_point &xother) const
	Equality operator. More...

DEBUGGING FACET
void	to_stream (std::ostream &xos=std::cout) const
	Write instance information to an ostream (default = stdout). More...
std::string	to_string () const
	Get instance information as a string. More...

Additional Inherited Members
Public Member Functions inherited from sheaf::any
bool	is_same_type (const any *other) const
	True if other is the same type as this. More...
virtual	~any ()
	Destructor. More...
bool	invariant_check () const
	True if invariant checking is enabled. More...
void	enable_invariant_check () const
	Enable invariant checking. More...
void	disable_invariant_check () const
	Disable invariant check. Intended for preventing recursive calls to invariant and for suppressing invariant checking during multi-phase initialization. More...
int	disable_invariance_check_request_depth () const
	Number of times disable_invariant_check has been called without matching call to enable_invariant_check. More...
Protected Member Functions inherited from sheaf::any
	any ()
	default constructor More...

Detailed Description

A point in chart space.

Definition at line 52 of file chart_point.h.

Member Typedef Documentation

coord_type

typedef chart_point_coord_type fiber_bundle::chart_point::coord_type

The type of local coordinate; the scalar type for the local coordinate vector space.

Definition at line 65 of file chart_point.h.

Constructor & Destructor Documentation

~chart_point()

fiber_bundle::chart_point::~chart_point ( )

virtual

Destructor.

Definition at line 79 of file chart_point.cc.

References chart_id().

Referenced by new_chart_point().

chart_point()

fiber_bundle::chart_point::chart_point ( )

protected

Default constructor.

Definition at line 347 of file chart_point.cc.

References _chart_id, chart_id(), sheaf::invalid_pod_index(), and invariant().

Referenced by invalidate().

Member Function Documentation

chart_id()

sheaf::pod_index_type fiber_bundle::chart_point::chart_id

(

)

const

The id of the chart this point is in.

Definition at line 96 of file chart_point.cc.

References put_chart_id().

Referenced by chart_point(), fields::discretization_hash::operator()(), fiber_bundle::operator<<(), operator=(), fields::pullback_map_entry::operator==(), operator==(), fiber_bundle::local_base_space_member::refine_point(), fiber_bundle::local_base_space_member::refine_point_pa(), fiber_bundle::structured_block::refine_point_pa(), fiber_bundle::structured_block_1d::refine_point_pa(), fiber_bundle::structured_block_2d::refine_point_pa(), fiber_bundle::structured_block_3d::refine_point_pa(), fiber_bundle::local_base_space_member::unrefine_point(), fiber_bundle::local_base_space_member::unrefine_point_pa(), fiber_bundle::structured_block::unrefine_point_pa(), fiber_bundle::structured_block_1d::unrefine_point_pa(), fiber_bundle::structured_block_2d::unrefine_point_pa(), fiber_bundle::structured_block_3d::unrefine_point_pa(), fiber_bundle::sec_vd::value_at_point_ua(), and ~chart_point().

clone()

virtual chart_point* fiber_bundle::chart_point::clone ( ) const

pure virtual

Virtual constructor, makes a new instance of the same type as this.

Reimplemented from sheaf::any.

Implemented in fiber_bundle::chart_point_3d, fiber_bundle::chart_point_2d, and fiber_bundle::chart_point_1d.

Referenced by fiber_bundle::local_base_space_member::refine_point(), and fiber_bundle::local_base_space_member::unrefine_point().

db()

int fiber_bundle::chart_point::db ( ) const

pure virtual

The dimension of this chart.

Is Abstract.

Postcondition

• result >= -1

Implemented in fiber_bundle::chart_point_3d, fiber_bundle::chart_point_2d, and fiber_bundle::chart_point_1d.

Definition at line 141 of file chart_point.cc.

References local_coord().

Referenced by invariant(), fiber_bundle::operator<<(), operator=(), operator==(), geometry::d_uniform_point_locator< DC, DB >::point_at_value(), geometry::d_bin_point_locator< DC, DB >::point_at_value(), geometry::cylindrical_point_locator::point_at_value(), geometry::db0_point_locator< DC >::point_at_value(), geometry::sec_ed_invertible::point_at_value_ua(), fields::discretization_pusher::push(), put_chart_id(), fiber_bundle::local_base_space_member::refine_point(), fiber_bundle::local_base_space_member::refine_point_pa(), fiber_bundle::structured_block::refine_point_pa(), fiber_bundle::structured_block_1d::refine_point_pa(), fiber_bundle::structured_block_2d::refine_point_pa(), fiber_bundle::structured_block_3d::refine_point_pa(), fiber_bundle::local_base_space_member::unrefine_point(), fiber_bundle::structured_block::unrefine_point_pa(), fiber_bundle::structured_block_1d::unrefine_point_pa(), fiber_bundle::structured_block_2d::unrefine_point_pa(), fiber_bundle::structured_block_3d::unrefine_point_pa(), and fiber_bundle::sec_vd::value_at_point_ua().

invalidate()

void fiber_bundle::chart_point::invalidate

(

)

Makes this invalid.

Postcondition

• !is_valid()

Definition at line 322 of file chart_point.cc.

References chart_point(), sheaf::invalid_pod_index(), and sheaf::is_valid().

Referenced by fields::base_space_map::base_space_map(), is_valid(), geometry::d_uniform_point_locator< DC, DB >::point_at_value(), geometry::d_bin_point_locator< DC, DB >::point_at_value(), geometry::cylindrical_point_locator::point_at_value(), geometry::db0_point_locator< DC >::point_at_value(), and fields::section_pusher::section_pusher().

invariant()

bool fiber_bundle::chart_point::invariant ( ) const

virtual

Class invariant.

Invariant

• any::invariant()

• -unexecutable( db() >= -1 )

Reimplemented from sheaf::any.

Reimplemented in fiber_bundle::chart_point_3d, fiber_bundle::chart_point_2d, and fiber_bundle::chart_point_1d.

Definition at line 393 of file chart_point.cc.

References db(), sheaf::any::disable_invariant_check(), sheaf::any::enable_invariant_check(), sheaf::any::invariant(), sheaf::any::invariant_check(), and is_ancestor_of().

Referenced by chart_point(), fiber_bundle::chart_point_1d::invariant(), fiber_bundle::chart_point_2d::invariant(), fiber_bundle::chart_point_3d::invariant(), operator=(), and operator==().

is_ancestor_of()

bool fiber_bundle::chart_point::is_ancestor_of ( const any *  other ) const

virtual

Conformance test; true if other conforms to this.

Precondition

• other != 0

Reimplemented from sheaf::any.

Reimplemented in fiber_bundle::chart_point_3d, fiber_bundle::chart_point_2d, and fiber_bundle::chart_point_1d.

Definition at line 427 of file chart_point.cc.

References operator=().

Referenced by invariant().

is_valid()

bool fiber_bundle::chart_point::is_valid

(

)

const

True if this ia a valid point in a chart.

Definition at line 303 of file chart_point.cc.

References invalidate(), and sheaf::is_valid().

Referenced by geometry::d_uniform_point_locator< DC, DB >::point_at_value(), geometry::d_bin_point_locator< DC, DB >::point_at_value(), geometry::cylindrical_point_locator::point_at_value(), geometry::db0_point_locator< DC >::point_at_value(), geometry::sec_ed_invertible::point_at_value_pa(), geometry::sec_ed_invertible::point_at_value_ua(), fields::field_vd::property_at_coordinates(), put_local_coords_zero(), and fiber_bundle::sec_vd::value_at_point_ua().

local_coord()

fiber_bundle::chart_point::coord_type fiber_bundle::chart_point::local_coord ( int  xi ) const

pure virtual

The xi-th local coordinate of this point.

Precondition

• (0 <= xi) && (xi < db())

Is Abstract.

Postcondition

• invariant()

Implemented in fiber_bundle::chart_point_3d, fiber_bundle::chart_point_2d, and fiber_bundle::chart_point_1d.

Definition at line 163 of file chart_point.cc.

References put_local_coord().

Referenced by db(), fiber_bundle::operator<<(), operator=(), operator==(), geometry::d_uniform_point_locator< DC, DB >::point_at_value(), geometry::d_bin_point_locator< DC, DB >::point_at_value(), geometry::cylindrical_point_locator::point_at_value(), geometry::sec_ed_invertible::point_at_value_pa(), geometry::sec_ed_invertible::point_at_value_ua(), fiber_bundle::structured_block_1d::unrefine_point_pa(), fiber_bundle::structured_block_2d::unrefine_point_pa(), and fiber_bundle::structured_block_3d::unrefine_point_pa().

local_coords() [1/2]

fiber_bundle::chart_point::coord_type * fiber_bundle::chart_point::local_coords ( )

pure virtual

The array of local coordinates.

Is Abstract.

Postcondition

• result != 0

Implemented in fiber_bundle::chart_point_3d, fiber_bundle::chart_point_2d, and fiber_bundle::chart_point_1d.

Definition at line 209 of file chart_point.cc.

Referenced by operator=(), geometry::d_bin_point_locator< DC, DB >::point_at_value(), geometry::cylindrical_point_locator::point_at_value(), fields::discretization_pusher::push(), put_local_coord(), fiber_bundle::structured_block_1d::refine_point_pa(), fiber_bundle::structured_block_2d::refine_point_pa(), fiber_bundle::structured_block_3d::refine_point_pa(), and fiber_bundle::sec_vd::value_at_point_ua().

local_coords() [2/2]

const fiber_bundle::chart_point::coord_type * fiber_bundle::chart_point::local_coords ( ) const

pure virtual

The array of local coordinates.

Is Abstract.

Postcondition

• result != 0

Implemented in fiber_bundle::chart_point_3d, fiber_bundle::chart_point_2d, and fiber_bundle::chart_point_1d.

Definition at line 231 of file chart_point.cc.

References put_local_coords().

new_chart_point()

fiber_bundle::chart_point * fiber_bundle::chart_point::new_chart_point ( int  xdb )

static

Factory method; creates a chart point with db() == xdb.

Precondition

• (1 <= xdb) && (xdb < 4)

Postcondition

• result != 0

Definition at line 43 of file chart_point.cc.

References ~chart_point().

Referenced by geometry::sec_ed_invertible::point_at_value().

operator=()

fiber_bundle::chart_point & fiber_bundle::chart_point::operator=

(

const chart_point &

xother

)

Assignment operator.

Postcondition

• invariant()

• chart_id() == xother.chart_id()

• for(int i = ( 0 ); i < ( (min(db(), xother.db())) ); ++ i ) isunordered_or_equals(local_coord(i), xother.local_coord(i))

• for(int i = ( (min(db(), xother.db())) ); i < ( db() ); ++ i ) local_coord(i) == 0.0

Definition at line 449 of file chart_point.cc.

References _chart_id, chart_id(), db(), invariant(), sheaf::isunordered_or_equals(), local_coord(), local_coords(), fiber_bundle::vd_algebra::min(), and operator==().

Referenced by is_ancestor_of(), fiber_bundle::chart_point_1d::operator=(), fiber_bundle::chart_point_2d::operator=(), and fiber_bundle::chart_point_3d::operator=().

operator==()

bool fiber_bundle::chart_point::operator==

(

const chart_point &

xother

)

const

Equality operator.

Postcondition

• invariant()

Definition at line 490 of file chart_point.cc.

References chart_id(), db(), invariant(), local_coord(), and to_stream().

Referenced by operator=().

put_chart_id() [1/2]

void fiber_bundle::chart_point::put_chart_id

(

pod_index_type

xchart

)

Sets chart_id() to xchart_id.

Postcondition

• chart_id() == xchart_id

Definition at line 103 of file chart_point.cc.

Referenced by geometry::d_bin_point_locator< DC, DB >::branch_points_at_value(), geometry::cylindrical_point_locator::branch_points_at_value(), chart_id(), geometry::db0_point_locator< DC >::find_closest_vertex_in_bin(), fields::property_disc_iterator_4_2::get_prop_disc_values(), fields::property_disc_iterator_4_3::get_prop_disc_values(), geometry::d_bin_point_locator< DC, DB >::point_at_value(), geometry::cylindrical_point_locator::point_at_value(), fields::pullback_map_entry::pullback_map_entry(), fields::discretization_pusher::push(), fiber_bundle::structured_block_1d::refine_point_pa(), fiber_bundle::structured_block_2d::refine_point_pa(), fiber_bundle::structured_block_3d::refine_point_pa(), tool::visualization_iterator_4_2::set_vtk_data(), tool::visualization_iterator_4_3::set_vtk_data(), fiber_bundle::structured_block_1d::unrefine_point_pa(), fiber_bundle::structured_block_2d::unrefine_point_pa(), and fiber_bundle::structured_block_3d::unrefine_point_pa().

put_chart_id() [2/2]

void fiber_bundle::chart_point::put_chart_id

(

const scoped_index &

xchart

)

Sets chart_id() to xchart_id.hub_pod().

Postcondition

• chart_id() == xchart_id.hub_pod()

Definition at line 122 of file chart_point.cc.

References db(), and sheaf::scoped_index::hub_pod().

put_local_coord()

void fiber_bundle::chart_point::put_local_coord ( int  xi, coord_type  xvalue  )

pure virtual

Sets the xi-th local coordinate of this point to xvalue.

Precondition

• (0 <= xi) && (xi < db())

Is Abstract.

Postcondition

• invariant()

• isunordered_or_equals(local_coord(xi), xvalue)

Implemented in fiber_bundle::chart_point_3d.

Definition at line 187 of file chart_point.cc.

References sheaf::isunordered_or_equals(), and local_coords().

Referenced by local_coord(), fiber_bundle::structured_block_1d::refine_point_pa(), fiber_bundle::structured_block_2d::refine_point_pa(), fiber_bundle::structured_block_3d::refine_point_pa(), fiber_bundle::structured_block_1d::unrefine_point_pa(), fiber_bundle::structured_block_2d::unrefine_point_pa(), and fiber_bundle::structured_block_3d::unrefine_point_pa().

put_local_coords()

void fiber_bundle::chart_point::put_local_coords	(	const coord_type *	xvalues,
		size_type	xvalues_ub
	)

Sets the local coordinates to the values in xvalues.

Precondition

• xvalues != 0

• xvalues_ub >= db()

Postcondition

• invariant()

• for(int i = ( 0 ); i < ( db() ); ++ i ) isunordered_or_equals(local_coord(i), xvalues[i])

Definition at line 253 of file chart_point.cc.

References sheaf::isunordered_or_equals(), and put_local_coords_zero().

Referenced by local_coords().

put_local_coords_zero()

void fiber_bundle::chart_point::put_local_coords_zero

(

)

Sets the local coordinates to the zero vector.

Postcondition

• invariant()

• for(int i = ( 0 ); i < ( db() ); ++ i ) local_coord(i) == 0.0

Definition at line 279 of file chart_point.cc.

References is_valid().

Referenced by put_local_coords().

to_stream()

void fiber_bundle::chart_point::to_stream

(

std::ostream &

xos = std::cout

)

const

Write instance information to an ostream (default = stdout).

Definition at line 528 of file chart_point.cc.

References to_string().

Referenced by operator==().

to_string()

std::string fiber_bundle::chart_point::to_string

(

)

const

Get instance information as a string.

Definition at line 535 of file chart_point.cc.

References fiber_bundle::operator<<().

Referenced by to_stream().

Member Data Documentation

_chart_id

pod_index_type fiber_bundle::chart_point::_chart_id

protected

The id of the chart this point is in.

Definition at line 148 of file chart_point.h.

Referenced by chart_point(), operator=(), fiber_bundle::chart_point_1d::operator=(), fiber_bundle::chart_point_2d::operator=(), and fiber_bundle::chart_point_3d::operator=().

---

The documentation for this class was generated from the following files:

• chart_point.h
• chart_point.cc