fiber_bundle::section_dof_map Class Reference

The abstract map from section dof ids to section dof values of heterogeneous type. More...

#include <section_dof_map.h>

Inheritance diagram for fiber_bundle::section_dof_map:

Public Member Functions
virtual const std::string &	class_name () const
	The name of the actual (possibly derived) class of this instance. More...
section_dof_map &	operator= (const section_dof_map &xother)
	Assignment operator. More...
virtual	~section_dof_map ()
	Destructor. More...
virtual bool	invariant () const
	The class invariant. More...
virtual sec_rep_space *	host () const
	The poset which hosts member() More...
virtual section_space_schema_member &	schema ()
	The schema on which this is allocated (mutable version). More...
virtual const section_space_schema_member &	schema () const
	The schema on which this is allocated (const version). More...
virtual bool	dof_in_bounds (pod_index_type xdof_id, bool xis_table_dofs) const
	True if and only if the dof asociated with id xdof_id is within the current capacity of the dofs storage. More...
virtual bool	dof_in_bounds (pod_index_type xdisc_id, pod_index_type xfiber_id, bool xis_table_dofs) const
	True if and only if the dof asociated with discretization id xdisc_id and fiber dof id xfiber_id is within the current capacity of the dofs storage. More...
virtual void	get_dof (pod_index_type xdisc_id, pod_index_type xfiber_dof_id, void *xdof, size_type xdof_size) const =0
	Copies the dof referred to by xdisc_id, xfiber_dof_id into xdof. More...
void	get_dof (pod_index_type xdisc_id, pod_index_type xfiber_dof_id, void *xdof, size_type xdof_size)
void	get_dof (const scoped_index &xdisc_id, const scoped_index &xfiber_dof_id, void *xdof, size_type xdof_size) const
	Copies the dof referred to by xdisc_id, xfiber_dof_id into xdof. More...
void	get_dof (const scoped_index &xdisc_id, const scoped_index &xfiber_dof_id, void *xdof, size_type xdof_size)
virtual void	put_dof (pod_index_type xdisc_id, pod_index_type xfiber_dof_id, const void *xdof, size_type xdof_size)=0
	Sets the dof referred to by xdof_id to the value at xdof. More...
void	put_dof (const scoped_index &xdisc_id, const scoped_index &xfiber_dof_id, const void *xdof, size_type xdof_size)
	Sets the dof referred to by xdof_id to the value at xdof. More...
virtual bool	fiber_in_bounds (pod_index_type xdisc_id, bool xis_table_dofs) const
	True if and only if the fiber asociated with discretization id xdisc_id is within the current capacity of the dofs storage. More...
virtual void	get_fiber (pod_index_type xdisc_id, void *xfiber, size_type xfiber_size) const
	Sets xfiber to the fiber referred to by discretization id xdisc_id. More...
void	get_fiber (const scoped_index &xdisc_id, void *xfiber, size_type xfiber_size) const
	Sets xfiber to the fiber referred to by discretization id xdisc_id. More...
virtual void	put_fiber (pod_index_type xdisc_id, const void *xfiber, size_type xfiber_size)=0
	Sets the fiber referred to by discretization id xdisc_id to xfiber. More...
void	put_fiber (const scoped_index &xdisc_id, const void *xfiber, size_type xfiber_size)
	Sets the fiber referred to by discretization id xdisc_id to xfiber. More...
virtual void	force_fiber (pod_index_type xdisc_id, const void *xfiber, size_type xfiber_size)
	Sets the fiber referred to by discretization id xdisc_id to xfiber; allocates additional memory if necessary. More...
void	force_fiber (const scoped_index &xdisc_id, const void *xfiber, size_type xfiber_size)
	Sets the fiber referred to by discretization id xdisc_id to xfiber; allocates additional memory if necessary. More...
virtual void	get_component (pod_index_type xfiber_dof_id, void *xcomponent, size_type xcomponent_size) const =0
	Sets xcomponent to the component referred to by fiber id xfiber_dof_id. More...
void	get_component (const scoped_index &xfiber_dof_id, void *xcomponent, size_type xcomponent_size) const
	Sets xcomponent to the component referred to by fiber id xfiber_dof_id. More...
virtual void	put_component (pod_index_type xfiber_dof_id, const void *xcomponent, size_type xcomponent_size)=0
	Sets the component referred to by fiber id xfiber_dof_id to xcomponent. More...
void	put_component (const scoped_index &xfiber_dof_id, const void *xcomponent, size_type xcomponent_size)
	Sets the component referred to by fiber id xfiber_dof_id to xcomponent. More...
virtual bool	supports_xfr_opt () const
	True if this dof map type supports dof tuple transfer optimization. /. More...
Public Member Functions inherited from sheaf::poset_dof_map
virtual poset_dof_map *	clone () const =0
	Virtual default constructor. More...
virtual poset_dof_map *	copy () const =0
	Virtual copy constructor. More...
poset_dof_map &	operator= (const poset_dof_map &xother)
	Assignment operator. More...
virtual	~poset_dof_map ()
	Destructor. More...
virtual void	init_row_dof_map (const poset_state_handle *xhost, pod_index_type xschema_mbr_id, int xschema_version)
	Initializes this as a map for row dofs in host xhost, with schema member specified by xschema_mbr_id and schema version xschema_version. More...
void	init_row_dof_map (const poset_state_handle *xhost, const scoped_index &xschema_mbr_id, int xschema_version)
	Initializes this as a map for row dofs in host xhost, with schema member specified by xschema_mbr_id and schema version xschema_version. More...
virtual dof_tuple_type	type_id () const =0
	An identifer for the type of dof tuple this is. More...
bool	is_initialized () const
	True if this has been initialized, that is, if the schema has been set and the dof map storage allocated. More...
const scoped_index &	index () const
	The index of this in host() dof tuple table. More...
bool	is_table_dof_map () const
	True if this is a table dof map. More...
int	dof_ct () const
	The number of dofs in this map. More...
primitive_value	dof (pod_index_type xdof_id) const
	The dof referred to by xdof_id. More...
primitive_value	dof (const scoped_index &xdof_id) const
	The dof referred to by xdof_id. More...
primitive_value	dof (const std::string &xname) const
	The dof with name xname. More...
void	put_dof (pod_index_type xdof_id, const primitive_value &xdof)
	Sets the dof referred to by xdof_id to xdof. More...
void	put_dof (const scoped_index &xdof_id, const primitive_value &xdof)
	Sets the dof referred to by xdof_id to xdof. More...
void	put_dof (const std::string &xname, const primitive_value &xdof)
	Sets the dof with name xname to xdof. More...
virtual void	get_dof (pod_index_type xdof_id, void *xdof, size_type xdof_size) const
	Copies the dof referred to by xdof_id into xdof. More...
void	get_dof (const scoped_index &xdof_id, void *xdof, size_type xdof_size) const
	Copies the dof referred to by xdof_id into xdof. More...
virtual void	put_dof (pod_index_type xdof_id, const void *xdof, size_type xdof_size)
	Sets the dof referred to by xdof_id to the value at xdof. More...
void	put_dof (const scoped_index &xdof_id, const void *xdof, size_type xdof_size)
	Sets the dof referred to by xdof_id to the value at xdof. More...
size_t	dof_tuple_ub () const
	The size of the dof tuple in bytes. More...
virtual void *	dof_tuple ()=0
	The dof tuple (mutable version). More...
virtual const void *	dof_tuple () const =0
	The dof tuple (const version). More...
virtual void	get_dof_tuple (void *xbuf, size_t xbuflen) const =0
	Copies the entire dof tuple from internal storage into xbuf. More...
virtual void	put_dof_tuple (const void *xbuf, size_t xbuflen)=0
	Copies the entire dof tuple from xbuf into internal storage. More...
void	get_dof_tuple (arg_list &xargs) const
	Copies the entire dof tuple from internal storage into xargs. More...
void	put_dof_tuple (const arg_list &xargs)
	Copies the entire dof tuple from xargs into internal storage. More...
void	copy_dof_tuple (const poset_dof_map &xother)
	Copies the dof tuple of xother into this. More...
virtual void	put_defaults ()
	Sets all dofs to defualt values. More...
unsigned int	ref_ct () const
	The number of references to this map. More...
void	inc_ref_ct ()
	Increase the number of references to this map by one;. More...
void	dec_ref_ct ()
	Decrease the number of references to this map by one. More...
int	version () const
	The version of the host of the schema this is defined on. More...
virtual const index_space_handle &	client_id_space () const
	The map from library ids to clients ids for the schema this is defined on. More...
std::string	to_string (const schema_poset_member &xschema) const
	Return schema member dof value as a string. More...
std::string	to_string () const
	Return dof values as a formated string. More...
Public Member Functions inherited from sheaf::any
virtual bool	is_ancestor_of (const any *other) const
	True if other conforms to this. More...
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...

Static Public Member Functions
static const std::string &	static_class_name ()
	The name of this class. More...
Static Public Member Functions inherited from sheaf::poset_dof_map
static const std::string &	static_class_name ()
	The name of this class. More...
static poset_dof_map *	new_dof_map (const std::string &xclass_name, dof_tuple_type xsheaf_base_class_id)
	Creates an uninitialized dof map of type xclass_name, if a prototype of that name exists, otherwise of type xsheaf_base_class_id. More...

Protected Member Functions
	section_dof_map ()
	Default constructor. More...
	section_dof_map (const section_dof_map &xother)
	Copy constructor. More...
	section_dof_map (sec_rep_space *xhost, pod_index_type xbase_id, int xversion)
	Creates a map for a (possibly partial) section of xhost defined on version xversion of the base space member identified by xbase_id. More...
Protected Member Functions inherited from sheaf::poset_dof_map
	poset_dof_map ()
	Default constructor;. More...
	poset_dof_map (const poset_dof_map &xother)
	Copy constructor. More...
	poset_dof_map (const poset_state_handle *xhost, bool xis_table_dof_map)
	Creates a map for the table dofs (xis_table_dofs true) or row dofs (xis_table dofs false) for use in host xhost. More...
	poset_dof_map (const schema_poset_member *xschema, bool xis_table_dof_map)
	Creates a map for the table dofs (xis_table_dofs true) or row dofs (xis_table dofs false) for use in host xhost. More...
virtual void	put_host (const poset_state_handle *xhost)
	Sets host() to xhost. More...
void	put_index (const scoped_index &xindex)
	Sets the index of the member for which this provides the dofs. More...
void	put_dof_ct (int xdof_ct)
	Sets dof_ct() to xdof_ct. More...
void	put_dof_tuple_ub (size_t xub)
	Sets dof_tuple_ub() to xub. More...
void	put_ref_ct (int xref_ct)
	Sets ref_ct() to xref_ct). More...
virtual void	allocate_dofs ()=0
	Allocates dof storage. More...
Protected Member Functions inherited from sheaf::any
	any ()
	default constructor More...

Friends
class	sec_rep_space_member

Additional Inherited Members
Static Protected Member Functions inherited from sheaf::poset_dof_map
static dof_map_factory &	factory ()
	The dof map factory. More...
Protected Attributes inherited from sheaf::poset_dof_map
poset_state_handle *	_host
	The host of the poset member for which this stores the dofs. More...
scoped_index	_index
	The poset member for which this stores the dofs. More...
schema_poset_member *	_schema
	The schema on which this is instantiated. More...
bool	_is_table_dof_map
	True if this is a table dof map. More...
int	_dof_ct
	The number of dofs in this map. More...
size_t	_dof_tuple_ub
	The size of the dof tuple. More...
unsigned int	_ref_ct
	The number of references to this map /. More...

Detailed Description

The abstract map from section dof ids to section dof values of heterogeneous type.

Definition at line 51 of file section_dof_map.h.

Constructor & Destructor Documentation

~section_dof_map()

fiber_bundle::section_dof_map::~section_dof_map ( )

virtual

Destructor.

Definition at line 101 of file section_dof_map.cc.

References invariant().

Referenced by operator=().

section_dof_map() [1/3]

fiber_bundle::section_dof_map::section_dof_map ( )

protected

Default constructor.

Definition at line 691 of file section_dof_map.cc.

Referenced by section_dof_map(), and supports_xfr_opt().

section_dof_map() [2/3]

fiber_bundle::section_dof_map::section_dof_map ( const section_dof_map &  xother )

protected

Copy constructor.

Definition at line 710 of file section_dof_map.cc.

References section_dof_map().

section_dof_map() [3/3]

fiber_bundle::section_dof_map::section_dof_map ( sec_rep_space *  xhost, pod_index_type  xbase_id, int  xversion  )

protected

Creates a map for a (possibly partial) section of xhost defined on version xversion of the base space member identified by xbase_id.

Precondition

• xhost != 0

• xhost->state_is_read_accessible()

• xhost->base().geqv(xbase_id)

• xhost->has_version(xversion)

Postcondition

• is_initialized()

• host() == xhost

• !index().is_valid()

• schema().base_space_id() == xbase_id

• schema().fiber_schema_id() == xhost->schema().fiber_schema_id()

• dof_ct() == schema().row_dof_ct()

• dof_tuple_ub() == schema().row_dof_tuple_ub()

• ref_ct() == 0

• version() == xhost->schema().unaliased_version(xversion)

Definition at line 730 of file section_dof_map.cc.

References sheaf::poset_dof_map::_dof_ct, sheaf::poset_dof_map::_dof_tuple_ub, sheaf::poset_dof_map::_host, sheaf::poset_dof_map::_index, sheaf::poset_dof_map::_is_table_dof_map, sheaf::poset_dof_map::_ref_ct, sheaf::poset_dof_map::_schema, fiber_bundle::section_space_schema_member::attach_to_state(), fiber_bundle::sec_rep_space::base(), fiber_bundle::section_space_schema_member::clone(), sheaf::poset_dof_map::dof_ct(), sheaf::schema_poset_member::dof_ct(), sheaf::poset_dof_map::dof_tuple_ub(), sheaf::schema_poset_member::dof_tuple_ub(), fiber_bundle::section_space_schema_member::fiber_schema_id(), sheaf::abstract_poset_member::geqv(), sheaf::poset_state_handle::has_version(), host(), fiber_bundle::section_space_schema_member::host(), sheaf::poset_dof_map::index(), sheaf::scoped_index::invalidate(), sheaf::poset_dof_map::is_initialized(), sheaf::is_valid(), sheaf::schema_poset_member::name(), fiber_bundle::section_space_schema_member::put_standard_name(), fiber_bundle::section_space_schema_member::put_version(), sheaf::poset_dof_map::ref_ct(), schema(), fiber_bundle::sec_rep_space::schema(), sheaf::read_write_monitor_handle::state_is_read_accessible(), sheaf::poset_component::unaliased_version(), and sheaf::poset_dof_map::version().

Member Function Documentation

class_name()

const std::string & fiber_bundle::section_dof_map::class_name ( ) const

virtual

The name of the actual (possibly derived) class of this instance.

Postcondition

• !result.empty()

Reimplemented from sheaf::poset_dof_map.

Reimplemented in fiber_bundle::sparse_section_dof_map, fiber_bundle::array_field_dof_map, fiber_bundle::sparse_field_dof_map, fiber_bundle::field_dof_map, and fiber_bundle::array_section_dof_map.

Definition at line 36 of file section_dof_map.cc.

References static_class_name().

dof_in_bounds() [1/2]

bool fiber_bundle::section_dof_map::dof_in_bounds ( pod_index_type  xdof_id, bool  xis_table_dofs  ) const

virtual

True if and only if the dof asociated with id xdof_id is within the current capacity of the dofs storage.

Reimplemented in fiber_bundle::array_section_dof_map.

Definition at line 233 of file section_dof_map.cc.

Referenced by schema().

dof_in_bounds() [2/2]

bool fiber_bundle::section_dof_map::dof_in_bounds ( pod_index_type  xdisc_id, pod_index_type  xfiber_id, bool  xis_table_dofs  ) const

virtual

True if and only if the dof asociated with discretization id xdisc_id and fiber dof id xfiber_id is within the current capacity of the dofs storage.

Reimplemented in fiber_bundle::array_section_dof_map.

Definition at line 255 of file section_dof_map.cc.

References get_dof().

fiber_in_bounds()

bool fiber_bundle::section_dof_map::fiber_in_bounds ( pod_index_type  xdisc_id, bool  xis_table_dofs  ) const

virtual

True if and only if the fiber asociated with discretization id xdisc_id is within the current capacity of the dofs storage.

Reimplemented in fiber_bundle::array_section_dof_map.

Definition at line 398 of file section_dof_map.cc.

References get_fiber().

Referenced by put_dof().

force_fiber() [1/2]

void fiber_bundle::section_dof_map::force_fiber ( pod_index_type  xdisc_id, const void *  xfiber, size_type  xfiber_size  )

virtual

Sets the fiber referred to by discretization id xdisc_id to xfiber; allocates additional memory if necessary.

Precondition

• schema().state_is_read_accessible()

• schema().discretization_id_space().contains(xdisc_id)

• -unexecutable( "xfiber points to buffer of size xfiber_size" )

• xfiber_size >= schema().fiber_size()

Reimplemented in fiber_bundle::array_section_dof_map.

Definition at line 522 of file section_dof_map.cc.

Referenced by put_fiber().

force_fiber() [2/2]

void fiber_bundle::section_dof_map::force_fiber	(	const scoped_index &	xdisc_id,
		const void *	xfiber,
		size_type	xfiber_size
	)

Sets the fiber referred to by discretization id xdisc_id to xfiber; allocates additional memory if necessary.

Precondition

• schema().state_is_read_accessible()

• schema().discretization_id_space().contains(xdisc_id)

• -unexecutable( "xfiber points to buffer of size xfiber_size" )

• xfiber_size >= schema().fiber_size()

Definition at line 549 of file section_dof_map.cc.

References get_component().

get_component() [1/2]

void fiber_bundle::section_dof_map::get_component ( pod_index_type  xfiber_dof_id, void *  xcomponent, size_type  xcomponent_size  ) const

pure virtual

Sets xcomponent to the component referred to by fiber id xfiber_dof_id.

Precondition

• schema().state_is_read_accessible()

• schema().fiber_schema_id_space(false).contains(xfiber_dof_id)

• -unexecutable( "xcomponent points to buffer of size xcomponent_size" )

• xcomponent_size >= schema().component_size(xfiber_dof_id)

Is Abstract.

Implemented in fiber_bundle::array_section_dof_map, fiber_bundle::sparse_section_dof_map, and fiber_bundle::array_field_dof_map.

Definition at line 574 of file section_dof_map.cc.

Referenced by force_fiber().

get_component() [2/2]

void fiber_bundle::section_dof_map::get_component	(	const scoped_index &	xfiber_dof_id,
		void *	xcomponent,
		size_type	xcomponent_size
	)		const

Sets xcomponent to the component referred to by fiber id xfiber_dof_id.

Precondition

• schema().state_is_read_accessible()

• schema().fiber_schema_id_space(false).contains(xfiber_dof_id)

• -unexecutable( "xcomponent points to buffer of size xcomponent_size" )

• xcomponent_size >= schema().component_size(xfiber_dof_id, false)

Definition at line 598 of file section_dof_map.cc.

References put_component().

get_dof() [1/4]

void fiber_bundle::section_dof_map::get_dof ( pod_index_type  xdisc_id, pod_index_type  xfiber_dof_id, void *  xdof, size_type  xdof_size  ) const

pure virtual

Copies the dof referred to by xdisc_id, xfiber_dof_id into xdof.

Precondition

• schema().state_is_read_accessible()

• schema().discretization_id_space().contains(xdisc_id)

• schema().fiber_schema_id_space(false).contains(xfiber_dof_id)

• -unexecutable( "xdof points to buffer of size xdof_size" )

• xdof_size >= schema().size(xdisc_id, xfiber_dof_id, false)

Is Abstract.

Implemented in fiber_bundle::array_section_dof_map, fiber_bundle::sparse_section_dof_map, fiber_bundle::array_field_dof_map, and fiber_bundle::array_sec_vd_dof_map.

Definition at line 277 of file section_dof_map.cc.

Referenced by dof_in_bounds(), get_dof(), fiber_bundle::array_sec_vd_dof_map::type_id(), fiber_bundle::sparse_section_dof_map::type_id(), and fiber_bundle::array_section_dof_map::type_id().

get_dof() [2/4]

void fiber_bundle::section_dof_map::get_dof ( pod_index_type  xdisc_id, pod_index_type  xfiber_dof_id, void *  xdof, size_type  xdof_size  )

inline

Hack:

: get_dof(pod_index_type, pod_index_type, void*, size_type) const has an implicit 0-th argument const section_dof_map*. When called on a non-const section_dof_map, a conversion is required on the implicit first argument. This triggers the C++ argument matching rules, which conclude there is an ambiguity with the old signature get_dof(const scoped_index&, bool, void*, size_t), even though the explicit arguments in the call appear to be an exact match. The following signature can be removed when the conflicting old signature is removed.

Definition at line 139 of file section_dof_map.h.

References get_dof().

get_dof() [3/4]

void fiber_bundle::section_dof_map::get_dof	(	const scoped_index &	xdisc_id,
		const scoped_index &	xfiber_dof_id,
		void *	xdof,
		size_type	xdof_size
	)		const

Copies the dof referred to by xdisc_id, xfiber_dof_id into xdof.

Precondition

• schema().state_is_read_accessible()

• schema().discretization_id_space().contains(xdisc_id)

• schema().fiber_schema_id_space(false).contains(xfiber_dof_id)

• -unexecutable( "dof_in_bounds(xdisc_id, xfiber_dof_id, false)" )

• -unexecutable( "xdof points to buffer of size xdof_size" )

• xdof_size >= schema().size(xdisc_id, xfiber_dof_id, false, false)

Definition at line 303 of file section_dof_map.cc.

References put_dof().

get_dof() [4/4]

void fiber_bundle::section_dof_map::get_dof ( const scoped_index &  xdisc_id, const scoped_index &  xfiber_dof_id, void *  xdof, size_type  xdof_size  )

inline

Hack:

: get_dof(const scoped_index&, const scoped_index&, void*, size_type) const has an implicit 0-th argument const section_dof_map*. When called on a non-const section_dof_map, a conversion is required on the implicit first argument. This triggers the C++ argument matching rules, which conclude there is an ambiguity with the old signature get_dof(const scoped_index&, bool, void*, size_t), even though the explicit arguments in the call appear to be an exact match. This signature can be removed when the conflicting old signature is removed.

Definition at line 165 of file section_dof_map.h.

References get_dof().

get_fiber() [1/2]

void fiber_bundle::section_dof_map::get_fiber ( pod_index_type  xdisc_id, void *  xfiber, size_type  xfiber_size  ) const

virtual

Sets xfiber to the fiber referred to by discretization id xdisc_id.

Precondition

• schema().state_is_read_accessible()

• schema().discretization_id_space().contains(xdisc_id)

• fiber_in_bounds(xdisc_id, false)

• -unexecutable( "xfiber points to buffer of size xfiber_size" )

• xfiber_size >= schema().fiber_size()

Is Abstract.

Reimplemented in fiber_bundle::array_section_dof_map, fiber_bundle::sparse_section_dof_map, and fiber_bundle::array_field_dof_map.

Definition at line 420 of file section_dof_map.cc.

Referenced by fiber_in_bounds().

get_fiber() [2/2]

void fiber_bundle::section_dof_map::get_fiber	(	const scoped_index &	xdisc_id,
		void *	xfiber,
		size_type	xfiber_size
	)		const

Sets xfiber to the fiber referred to by discretization id xdisc_id.

Precondition

• schema().state_is_read_accessible()

• schema().discretization_id_space().contains(xdisc_id)

• -unexecutable( "fiber_in_bounds(xdisc_id, false)" )

• -unexecutable( "xfiber points to buffer of size xfiber_size" )

• xfiber_size >= schema().fiber_size()

Definition at line 445 of file section_dof_map.cc.

References put_fiber().

host()

fiber_bundle::sec_rep_space * fiber_bundle::section_dof_map::host ( ) const

virtual

The poset which hosts member()

Postcondition

• (result == 0) == (poset_dof_map::host() == 0)

Reimplemented from sheaf::poset_dof_map.

Definition at line 165 of file section_dof_map.cc.

References schema().

Referenced by fiber_bundle::array_field_dof_map::allocate_dofs(), fiber_bundle::sparse_field_dof_map::get_dof(), invariant(), fiber_bundle::sparse_field_dof_map::put_dof(), fiber_bundle::array_section_dof_map::put_dof_tuple(), and section_dof_map().

invariant()

bool fiber_bundle::section_dof_map::invariant ( ) const

virtual

The class invariant.

Reimplemented from sheaf::poset_dof_map.

Reimplemented in fiber_bundle::sparse_section_dof_map, fiber_bundle::array_field_dof_map, fiber_bundle::sparse_field_dof_map, fiber_bundle::array_section_dof_map, fiber_bundle::array_sec_vd_dof_map, and fiber_bundle::field_dof_map.

Definition at line 120 of file section_dof_map.cc.

References host().

Referenced by fiber_bundle::field_dof_map::invariant(), and ~section_dof_map().

operator=()

fiber_bundle::section_dof_map & fiber_bundle::section_dof_map::operator=

(

const section_dof_map &

xother

)

Assignment operator.

Precondition

• xother.is_initialized()

Definition at line 80 of file section_dof_map.cc.

References sheaf::poset_dof_map::is_initialized(), and ~section_dof_map().

Referenced by fiber_bundle::field_dof_map::operator=(), fiber_bundle::array_section_dof_map::operator=(), fiber_bundle::sparse_section_dof_map::operator=(), and static_class_name().

put_component() [1/2]

void fiber_bundle::section_dof_map::put_component ( pod_index_type  xfiber_dof_id, const void *  xcomponent, size_type  xcomponent_size  )

pure virtual

Sets the component referred to by fiber id xfiber_dof_id to xcomponent.

Precondition

• schema().state_is_read_accessible()

• schema().fiber_schema_id_space(false).contains(xfiber_dof_id)

• -unexecutable( "xcomponent points to buffer of size xcomponent_size" )

• xcomponent_size >= schema().component_size(xfiber_dof_id)

Is Abstract.

Implemented in fiber_bundle::array_section_dof_map, fiber_bundle::sparse_section_dof_map, and fiber_bundle::array_field_dof_map.

Definition at line 624 of file section_dof_map.cc.

Referenced by get_component().

put_component() [2/2]

void fiber_bundle::section_dof_map::put_component	(	const scoped_index &	xfiber_dof_id,
		const void *	xcomponent,
		size_type	xcomponent_size
	)

Sets the component referred to by fiber id xfiber_dof_id to xcomponent.

Precondition

• schema().state_is_read_accessible()

• schema().fiber_schema_id_space(false).contains(xfiber_dof_id)

• -unexecutable( "xcomponent points to buffer of size xcomponent_size" )

• xcomponent_size >= schema().component_size(xfiber_dof_id, false)

Definition at line 648 of file section_dof_map.cc.

References supports_xfr_opt().

put_dof() [1/2]

void fiber_bundle::section_dof_map::put_dof ( pod_index_type  xdisc_id, pod_index_type  xfiber_dof_id, const void *  xdof, size_type  xdof_size  )

pure virtual

Sets the dof referred to by xdof_id to the value at xdof.

Precondition

• schema().state_is_read_accessible()

• schema().discretization_id_space().contains(xdisc_id)

• schema().fiber_schema_id_space(false).contains(xfiber_dof_id)

• dof_in_bounds(xdisc_id, xfiber_dof_id, false)

• -unexecutable( "xdof points to buffer of size xdof_size" )

• xdof_size >= schema().size(xdisc_id, xfiber_dof_id, false)

Is Abstract.

Implemented in fiber_bundle::array_section_dof_map, fiber_bundle::sparse_section_dof_map, fiber_bundle::array_field_dof_map, and fiber_bundle::array_sec_vd_dof_map.

Definition at line 337 of file section_dof_map.cc.

Referenced by fiber_bundle::sec_vd_algebra::assign(), get_dof(), fiber_bundle::array_sec_vd_dof_map::type_id(), fiber_bundle::sparse_section_dof_map::type_id(), and fiber_bundle::array_section_dof_map::type_id().

put_dof() [2/2]

void fiber_bundle::section_dof_map::put_dof	(	const scoped_index &	xdisc_id,
		const scoped_index &	xfiber_dof_id,
		const void *	xdof,
		size_type	xdof_size
	)

Sets the dof referred to by xdof_id to the value at xdof.

Precondition

• schema().state_is_read_accessible()

• schema().discretization_id_space().contains(xdisc_id)

• schema().fiber_schema_id_space(false).contains(xfiber_dof_id)

• -unexecutable( "dof_in_bounds(xdisc_id, xfiber_dof_id, false)" )

• -unexecutable( "xdof points to buffer of size xdof_size" )

• xdof_size >= schema().size(xdisc_id, xfiber_dof_id, false, false)

Definition at line 363 of file section_dof_map.cc.

References fiber_in_bounds().

put_fiber() [1/2]

void fiber_bundle::section_dof_map::put_fiber ( pod_index_type  xdisc_id, const void *  xfiber, size_type  xfiber_size  )

pure virtual

Sets the fiber referred to by discretization id xdisc_id to xfiber.

Precondition

• schema().state_is_read_accessible()

• schema().discretization_id_space().contains(xdisc_id)

• fiber_in_bounds(xdisc_id, false)

• -unexecutable( "xfiber points to buffer of size xfiber_size" )

• xfiber_size >= schema().fiber_size()

Is Abstract.

Implemented in fiber_bundle::array_section_dof_map, fiber_bundle::sparse_section_dof_map, and fiber_bundle::array_field_dof_map.

Definition at line 471 of file section_dof_map.cc.

Referenced by get_fiber().

put_fiber() [2/2]

void fiber_bundle::section_dof_map::put_fiber	(	const scoped_index &	xdisc_id,
		const void *	xfiber,
		size_type	xfiber_size
	)

Sets the fiber referred to by discretization id xdisc_id to xfiber.

Precondition

• schema().state_is_read_accessible()

• schema().discretization_id_space().contains(xdisc_id)

• -unexecutable( "fiber_in_bounds(xdisc_id, false)" )

• -unexecutable( "xfiber points to buffer of size xfiber_size" )

• xfiber_size >= schema().fiber_size()

Definition at line 496 of file section_dof_map.cc.

References force_fiber().

schema() [1/2]

fiber_bundle::section_space_schema_member & fiber_bundle::section_dof_map::schema ( )

virtual

The schema on which this is allocated (mutable version).

Precondition

• is_initialized()

Reimplemented from sheaf::poset_dof_map.

Definition at line 187 of file section_dof_map.cc.

Referenced by fiber_bundle::array_section_dof_map::array_section_dof_map(), fiber_bundle::array_section_dof_map::dof_in_bounds(), fiber_bundle::array_section_dof_map::fiber_in_bounds(), fiber_bundle::array_section_dof_map::force_fiber(), fiber_bundle::array_field_dof_map::get_component(), fiber_bundle::sparse_section_dof_map::get_component(), fiber_bundle::array_section_dof_map::get_component(), fiber_bundle::sparse_field_dof_map::get_component_dofs(), fiber_bundle::array_field_dof_map::get_component_dofs(), fiber_bundle::sparse_field_dof_map::get_discretization_dofs(), fiber_bundle::array_field_dof_map::get_discretization_dofs(), fiber_bundle::array_sec_vd_dof_map::get_dof(), fiber_bundle::sparse_field_dof_map::get_dof(), fiber_bundle::array_field_dof_map::get_dof(), fiber_bundle::sparse_section_dof_map::get_dof(), fiber_bundle::array_section_dof_map::get_dof(), fiber_bundle::sparse_section_dof_map::get_dof_tuple(), fiber_bundle::sparse_field_dof_map::get_dof_tuple(), fiber_bundle::array_field_dof_map::get_fiber(), fiber_bundle::sparse_section_dof_map::get_fiber(), fiber_bundle::array_section_dof_map::get_fiber(), host(), fiber_bundle::array_field_dof_map::put_component(), fiber_bundle::sparse_section_dof_map::put_component(), fiber_bundle::array_section_dof_map::put_component(), fiber_bundle::sparse_field_dof_map::put_component_dofs(), fiber_bundle::array_field_dof_map::put_component_dofs(), fiber_bundle::sparse_field_dof_map::put_discretization_dofs(), fiber_bundle::array_field_dof_map::put_discretization_dofs(), fiber_bundle::array_sec_vd_dof_map::put_dof(), fiber_bundle::array_field_dof_map::put_dof(), fiber_bundle::sparse_field_dof_map::put_dof(), fiber_bundle::sparse_section_dof_map::put_dof(), fiber_bundle::array_section_dof_map::put_dof(), fiber_bundle::sparse_section_dof_map::put_dof_tuple(), fiber_bundle::array_section_dof_map::put_dof_tuple(), fiber_bundle::sparse_field_dof_map::put_dof_tuple(), fiber_bundle::array_field_dof_map::put_fiber(), fiber_bundle::sparse_section_dof_map::put_fiber(), fiber_bundle::array_section_dof_map::put_fiber(), fiber_bundle::array_section_dof_map::reserve_fiber(), and section_dof_map().

schema() [2/2]

const fiber_bundle::section_space_schema_member & fiber_bundle::section_dof_map::schema ( ) const

virtual

The schema on which this is allocated (const version).

Precondition

• is_initialized()

Reimplemented from sheaf::poset_dof_map.

Definition at line 208 of file section_dof_map.cc.

References dof_in_bounds().

static_class_name()

const std::string & fiber_bundle::section_dof_map::static_class_name ( )

static

The name of this class.

Postcondition

• !result.empty()

• result == "section_dof_map"

Definition at line 56 of file section_dof_map.cc.

References operator=().

Referenced by class_name().

supports_xfr_opt()

bool fiber_bundle::section_dof_map::supports_xfr_opt ( ) const

virtual

True if this dof map type supports dof tuple transfer optimization. /.

Hack:

dof tuple transfer hack. /

Hack:

dof tuple transfer hack.

Reimplemented from sheaf::poset_dof_map.

Reimplemented in fiber_bundle::sparse_field_dof_map, and fiber_bundle::sparse_section_dof_map.

Definition at line 679 of file section_dof_map.cc.

References section_dof_map().

Referenced by put_component().

---

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

• section_dof_map.h
• section_dof_map.cc