OBSOLETE: use sheaf::poset_type, sheaf::dof_tuple_type, etc. Retained only because swig wraps only class members. More...

#include <sheaf_constants.h>

Public Types
typedef poset_type	poset_type
	Identifiers for poset types. More...

typedef dof_tuple_type	dof_tuple_type
	Identifiers for dof tuple types. More...

typedef primitive_type	primitive_type
	Type ids for primitives. More...

typedef primitive_descriptor	primitive_descriptor

Static Public Member Functions
static poset_type	poset_type_id (int xi)
	The poset type associated with int xi; converts int to poset type. More...

static const string &	dof_tuple_type_to_name (dof_tuple_type xdt)
	The name of the enumerator xdt. More...

static dof_tuple_type	dof_tuple_type_from_name (const string &xname)
	The enumerator with name xname. More...

static dof_tuple_type	dof_tuple_type_id (int xi)
	The dof tuple type associated with int xi; converts int to dof tuple type. More...

static const int	NOT_A_VERSION ()
	The void version. More...

static const int	COARSEST_COMMON_REFINEMENT_VERSION ()
	The version of the coarsest common refinement of all other versions. More...

static const int	CURRENT_HOST_VERSION ()
	An alias for the current version of a poset. More...

static const int	CURRENT_MEMBER_VERSION ()
	An alias for the current version of a member. More...

static const scoped_index	BOTTOM_INDEX ()
	The index of the bottom member of a poset. More...

static const scoped_index	TOP_INDEX ()
	The index of the top member of a poset. More...

static const scoped_index	PRIMITIVES_SCHEMA_INDEX ()
	Index of primitives schema poset. More...

static const scoped_index	NAMESPACE_SCHEMA_INDEX ()
	Index of namespace schema poset. More...

static const scoped_index	PRIMITIVES_INDEX ()
	Index of primitives poset. More...

static const scoped_index	SCHEMA_DEFINITIONS_INDEX ()
	Index of schema definitions jrm. More...

static const scoped_index	JIMS_INDEX ()
	The index of the jims subposet of a poset. More...

static const scoped_index	WHOLE_INDEX ()
	The index of the whole subposet; the top of the powerset of a poset. More...

static const scoped_index	RESIDENT_INDEX ()
	The index of the resident subposet of a poset. More...

static const scoped_index	TOC_INDEX ()
	Alias for the table of contents subposet. More...

static const scoped_index	EMPTY_DOF_TUPLE_INDEX ()
	The index of the (unique) empty dof map, i.e. the dof map with dof_ct() == 0. More...

static string	primitive_type_to_name (primitive_type xpt)
	The name of the enumerator xpt. More...

static primitive_type	primitive_type_from_name (const string &xname)
	The enumerator with name xname. More...

static primitive_type	primitive_type_from_index (int xindex)
	The enumerator corresponding to primitive index xindex. More...

static bool	is_primitive_index (int xindex)
	True if xindex is a valid primitive index. More...

static primitive_descriptor	primitive_description (int xindex)
	A descriptor for the primitive with index xindex. More...

static size_t	max_primitive_size ()
	The size of the largest primitive. More...

static size_t	align (const size_t xoffset, const size_t xalignment)
	Smallest offset greater than or equal to xoffset that has alignment xalignment. More...

static void	check_lps_script_has_run ()
	Function to test for whether the LPS script has been executed. More...

Detailed Description

OBSOLETE: use sheaf::poset_type, sheaf::dof_tuple_type, etc. Retained only because swig wraps only class members.

Type declarations and constant definitions used throughout the sheaf system.

Definition at line 68 of file sheaf_constants.h.

Member Typedef Documentation

◆ dof_tuple_type

typedef dof_tuple_type sheaf::sheaf_constants::dof_tuple_type

Identifiers for dof tuple types.

Definition at line 95 of file sheaf_constants.h.

◆ poset_type

typedef poset_type sheaf::sheaf_constants::poset_type

Identifiers for poset types.

Definition at line 80 of file sheaf_constants.h.

◆ primitive_type

typedef primitive_type sheaf::sheaf_constants::primitive_type

Type ids for primitives.

Issue:: does the above really belong here?

Definition at line 228 of file sheaf_constants.h.

Member Function Documentation

◆ align()

size_t sheaf::sheaf_constants::align	(	const size_t	xoffset,
		const size_t	xalignment
	)

static

Smallest offset greater than or equal to xoffset that has alignment xalignment.

Definition at line 271 of file sheaf_constants.cc.

References sheaf::align(), and check_lps_script_has_run().

Referenced by max_primitive_size().

◆ BOTTOM_INDEX()

const scoped_index sheaf::sheaf_constants::BOTTOM_INDEX ( )

static

The index of the bottom member of a poset.

Definition at line 105 of file sheaf_constants.cc.

References TOP_INDEX().

Referenced by CURRENT_MEMBER_VERSION().

◆ check_lps_script_has_run()

void sheaf::sheaf_constants::check_lps_script_has_run ( )

static

Function to test for whether the LPS script has been executed.

Checks to see if the environment variable LPS_SCRIPT_HAS_RUN has been set. If not, the calling program is forced to exit with a fatal error message; otherwise this method does nothing.

Definition at line 284 of file sheaf_constants.cc.

References sheaf::check_lps_script_has_run().

Referenced by align().

◆ COARSEST_COMMON_REFINEMENT_VERSION()

const int sheaf::sheaf_constants::COARSEST_COMMON_REFINEMENT_VERSION ( )

static

The version of the coarsest common refinement of all other versions.

Definition at line 76 of file sheaf_constants.cc.

References CURRENT_HOST_VERSION().

Referenced by NOT_A_VERSION().

◆ CURRENT_HOST_VERSION()

const int sheaf::sheaf_constants::CURRENT_HOST_VERSION ( )

static

An alias for the current version of a poset.

Definition at line 84 of file sheaf_constants.cc.

References CURRENT_MEMBER_VERSION().

Referenced by COARSEST_COMMON_REFINEMENT_VERSION().

◆ CURRENT_MEMBER_VERSION()

const int sheaf::sheaf_constants::CURRENT_MEMBER_VERSION ( )

static

An alias for the current version of a member.

Definition at line 92 of file sheaf_constants.cc.

References BOTTOM_INDEX().

Referenced by CURRENT_HOST_VERSION().

◆ dof_tuple_type_from_name()

sheaf::sheaf_constants::dof_tuple_type sheaf::sheaf_constants::dof_tuple_type_from_name ( const string & xname )

static

The enumerator with name xname.

Definition at line 46 of file sheaf_constants.cc.

References sheaf::dof_tuple_type_from_name(), and dof_tuple_type_id().

Referenced by dof_tuple_type_to_name().

◆ dof_tuple_type_id()

sheaf::sheaf_constants::dof_tuple_type sheaf::sheaf_constants::dof_tuple_type_id ( int xi )

static

The dof tuple type associated with int xi; converts int to dof tuple type.

Definition at line 53 of file sheaf_constants.cc.

References sheaf::dof_tuple_type_id(), and NOT_A_VERSION().

Referenced by dof_tuple_type_from_name().

◆ dof_tuple_type_to_name()

const string & sheaf::sheaf_constants::dof_tuple_type_to_name ( dof_tuple_type xdt )

static

The name of the enumerator xdt.

Definition at line 39 of file sheaf_constants.cc.

References dof_tuple_type_from_name(), and sheaf::dof_tuple_type_to_name().

Referenced by poset_type_id().

◆ EMPTY_DOF_TUPLE_INDEX()

const scoped_index sheaf::sheaf_constants::EMPTY_DOF_TUPLE_INDEX ( )

static

The index of the (unique) empty dof map, i.e. the dof map with dof_ct() == 0.

Note on restriction to BOTTOM: If the schema is restricted to BOTTOM, then the dof tuple is empty. As with the empty set and the null vector, we treat the empty dof tuple as unique. So all members of a poset on the BOTTOM schema share the same dof tuple, which contains no dofs. The dof tuple id for the empty dof tuple is 0. This structure is the same for both internal and external posets.

Definition at line 212 of file sheaf_constants.cc.

References primitive_type_to_name().

Referenced by TOC_INDEX().

◆ is_primitive_index()

bool sheaf::sheaf_constants::is_primitive_index ( int xindex )

static

True if xindex is a valid primitive index.

Definition at line 246 of file sheaf_constants.cc.

References sheaf::is_primitive_index(), and primitive_description().

Referenced by primitive_type_from_index().

◆ JIMS_INDEX()

const scoped_index sheaf::sheaf_constants::JIMS_INDEX ( )

static

The index of the jims subposet of a poset.

Definition at line 170 of file sheaf_constants.cc.

References WHOLE_INDEX().

Referenced by SCHEMA_DEFINITIONS_INDEX().

◆ max_primitive_size()

size_t sheaf::sheaf_constants::max_primitive_size ( )

static

The size of the largest primitive.

Definition at line 264 of file sheaf_constants.cc.

References align().

Referenced by primitive_description().

◆ NAMESPACE_SCHEMA_INDEX()

const scoped_index sheaf::sheaf_constants::NAMESPACE_SCHEMA_INDEX ( )

static

Index of namespace schema poset.

Definition at line 137 of file sheaf_constants.cc.

References PRIMITIVES_INDEX().

Referenced by PRIMITIVES_SCHEMA_INDEX().

◆ NOT_A_VERSION()

const int sheaf::sheaf_constants::NOT_A_VERSION ( )

static

The void version.

Definition at line 68 of file sheaf_constants.cc.

References COARSEST_COMMON_REFINEMENT_VERSION().

Referenced by dof_tuple_type_id().

◆ poset_type_id()

sheaf::sheaf_constants::poset_type sheaf::sheaf_constants::poset_type_id ( int xi )

static

The poset type associated with int xi; converts int to poset type.

Definition at line 28 of file sheaf_constants.cc.

References dof_tuple_type_to_name(), and sheaf::poset_type_id().

◆ primitive_description()

sheaf::sheaf_constants::primitive_descriptor sheaf::sheaf_constants::primitive_description ( int xindex )

static

A descriptor for the primitive with index xindex.

Definition at line 257 of file sheaf_constants.cc.

References max_primitive_size(), and primitive_description().

Referenced by is_primitive_index(), and primitive_description().

◆ primitive_type_from_index()

sheaf::sheaf_constants::primitive_type sheaf::sheaf_constants::primitive_type_from_index ( int xindex )

static

The enumerator corresponding to primitive index xindex.

Definition at line 239 of file sheaf_constants.cc.

References sheaf::primitive_attributes::id(), and is_primitive_index().

Referenced by primitive_type_from_name().

◆ primitive_type_from_name()

sheaf::sheaf_constants::primitive_type sheaf::sheaf_constants::primitive_type_from_name ( const string & xname )

static

The enumerator with name xname.

Definition at line 232 of file sheaf_constants.cc.

References sheaf::primitive_attributes::id(), and primitive_type_from_index().

Referenced by primitive_type_to_name().

◆ primitive_type_to_name()

string sheaf::sheaf_constants::primitive_type_to_name ( primitive_type xpt )

static

The name of the enumerator xpt.

Definition at line 225 of file sheaf_constants.cc.

References sheaf::primitive_attributes::name(), and primitive_type_from_name().

Referenced by EMPTY_DOF_TUPLE_INDEX().

◆ PRIMITIVES_INDEX()

const scoped_index sheaf::sheaf_constants::PRIMITIVES_INDEX ( )

static

Index of primitives poset.

Definition at line 146 of file sheaf_constants.cc.

References SCHEMA_DEFINITIONS_INDEX().

Referenced by NAMESPACE_SCHEMA_INDEX().

◆ PRIMITIVES_SCHEMA_INDEX()

const scoped_index sheaf::sheaf_constants::PRIMITIVES_SCHEMA_INDEX ( )

static

Index of primitives schema poset.

Definition at line 128 of file sheaf_constants.cc.

References NAMESPACE_SCHEMA_INDEX().

Referenced by TOP_INDEX().

◆ RESIDENT_INDEX()

const scoped_index sheaf::sheaf_constants::RESIDENT_INDEX ( )

static

The index of the resident subposet of a poset.

Definition at line 188 of file sheaf_constants.cc.

References TOC_INDEX().

Referenced by WHOLE_INDEX().

◆ SCHEMA_DEFINITIONS_INDEX()

const scoped_index sheaf::sheaf_constants::SCHEMA_DEFINITIONS_INDEX ( )

static

Index of schema definitions jrm.

Definition at line 155 of file sheaf_constants.cc.

References JIMS_INDEX().

Referenced by PRIMITIVES_INDEX().

◆ TOC_INDEX()

const scoped_index sheaf::sheaf_constants::TOC_INDEX ( )

static

Alias for the table of contents subposet.

Definition at line 197 of file sheaf_constants.cc.

References EMPTY_DOF_TUPLE_INDEX().

Referenced by RESIDENT_INDEX().

◆ TOP_INDEX()

const scoped_index sheaf::sheaf_constants::TOP_INDEX ( )

static

The index of the top member of a poset.

Definition at line 114 of file sheaf_constants.cc.

References PRIMITIVES_SCHEMA_INDEX().

Referenced by BOTTOM_INDEX().

◆ WHOLE_INDEX()

const scoped_index sheaf::sheaf_constants::WHOLE_INDEX ( )

static

The index of the whole subposet; the top of the powerset of a poset.

Definition at line 179 of file sheaf_constants.cc.

References RESIDENT_INDEX().

Referenced by JIMS_INDEX().

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

Public Types

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ dof_tuple_type

◆ poset_type

◆ primitive_type

Member Function Documentation

◆ align()

◆ BOTTOM_INDEX()

◆ check_lps_script_has_run()

◆ COARSEST_COMMON_REFINEMENT_VERSION()

◆ CURRENT_HOST_VERSION()

◆ CURRENT_MEMBER_VERSION()

◆ dof_tuple_type_from_name()

◆ dof_tuple_type_id()

◆ dof_tuple_type_to_name()

◆ EMPTY_DOF_TUPLE_INDEX()

◆ is_primitive_index()

◆ JIMS_INDEX()

◆ max_primitive_size()

◆ NAMESPACE_SCHEMA_INDEX()

◆ NOT_A_VERSION()

◆ poset_type_id()

◆ primitive_description()

◆ primitive_type_from_index()

◆ primitive_type_from_name()

◆ primitive_type_to_name()

◆ PRIMITIVES_INDEX()

◆ PRIMITIVES_SCHEMA_INDEX()

◆ RESIDENT_INDEX()

◆ SCHEMA_DEFINITIONS_INDEX()

◆ TOC_INDEX()

◆ TOP_INDEX()

◆ WHOLE_INDEX()