sheaf::dof_map_factory Class Reference

A factory for creating dof maps. More...

#include <dof_map_factory.h>

Public Member Functions
virtual	~dof_map_factory ()
	Destructor. More...
poset_dof_map *	new_dof_map (const std::string &xclient_class_name, dof_tuple_type xsheaf_base_class_id)
	Creates an uninitialized dof map of type xclient_class_name or type xsheaf_base_class_id if no prototype for xclient_class_name. More...
void	insert_prototype (const poset_dof_map *xprototype)
	Sets xprototype as the prototype for its client class. More...
void	insert_prototype (dof_tuple_type xtype_id, const poset_dof_map *xprototype)
	Sets xprototype as the prototype for type xtype_id. More...
void	delete_prototype (const std::string &xclass_name)
	Removes the prototype for handles of type xclass_name. More...
bool	contains_prototype (const std::string &xclass_name) const
	True if the set of prototypes contains a prototype for handles of type xclass_name. More...
bool	contains_prototype (dof_tuple_type xtype_id) const
	True if the set of prototypes contains a prototype for handles of type xtype_id. More...

Friends
class	poset_dof_map

Detailed Description

A factory for creating dof maps.

Definition at line 51 of file dof_map_factory.h.

Constructor & Destructor Documentation

~dof_map_factory()

sheaf::dof_map_factory::~dof_map_factory ( )

virtual

Destructor.

Postcondition

• -unexecutable( "All prototypes have been deleted." )

Definition at line 36 of file dof_map_factory.cc.

References new_dof_map().

Member Function Documentation

contains_prototype() [1/2]

bool sheaf::dof_map_factory::contains_prototype

(

const std::string &

xclass_name

)

const

True if the set of prototypes contains a prototype for handles of type xclass_name.

Definition at line 211 of file dof_map_factory.cc.

Referenced by delete_prototype().

contains_prototype() [2/2]

bool sheaf::dof_map_factory::contains_prototype

(

dof_tuple_type

xtype_id

)

const

True if the set of prototypes contains a prototype for handles of type xtype_id.

Definition at line 234 of file dof_map_factory.cc.

delete_prototype()

void sheaf::dof_map_factory::delete_prototype

(

const std::string &

xclass_name

)

Removes the prototype for handles of type xclass_name.

Postcondition

• !contains_prototype(xclass_name)

Definition at line 179 of file dof_map_factory.cc.

References contains_prototype(), and sheaf::poset_dof_map::is_initialized().

Referenced by insert_prototype().

insert_prototype() [1/2]

void sheaf::dof_map_factory::insert_prototype

(

const poset_dof_map *

xprototype

)

Sets xprototype as the prototype for its client class.

Precondition

• xprototype != 0

• !xprototype->is_initialized()

Postcondition

• contains_prototype(xprototype->class_name())

Definition at line 118 of file dof_map_factory.cc.

References sheaf::poset_dof_map::class_name(), and sheaf::poset_dof_map::is_initialized().

Referenced by sheaf::namespace_poset_dof_map::allocate_dofs(), fiber_bundle::sparse_section_dof_map::allocate_dofs(), fiber_bundle::array_section_dof_map::allocate_dofs(), fiber_bundle::sparse_field_dof_map::allocate_dofs(), fiber_bundle::array_field_dof_map::allocate_dofs(), sheaf::array_poset_dof_map::dof_in_bounds(), new_dof_map(), fiber_bundle::array_sec_vd_dof_map::put_dof(), and sheaf::primitives_poset_dof_map::put_host().

insert_prototype() [2/2]

void sheaf::dof_map_factory::insert_prototype	(	dof_tuple_type	xtype_id,
		const poset_dof_map *	xprototype
	)

Sets xprototype as the prototype for type xtype_id.

Precondition

• xprototype != 0

• !xprototype->is_initialized()

Postcondition

• contains_prototype(xtype_id)

Definition at line 156 of file dof_map_factory.cc.

References delete_prototype(), and sheaf::poset_dof_map::is_initialized().

new_dof_map()

sheaf::poset_dof_map * sheaf::dof_map_factory::new_dof_map	(	const std::string &	xclient_class_name,
		dof_tuple_type	xsheaf_base_class_id
	)

Creates an uninitialized dof map of type xclient_class_name or type xsheaf_base_class_id if no prototype for xclient_class_name.

Precondition

• contains_prototype(xclient_class_name) || contains_prototype(xsheaf_base_class_id)

Postcondition

• result != 0

• !result->is_initialized()

Definition at line 69 of file dof_map_factory.cc.

References sheaf::poset_dof_map::clone(), insert_prototype(), and sheaf::poset_dof_map::is_initialized().

Referenced by ~dof_map_factory().

---

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

• dof_map_factory.h
• dof_map_factory.cc