stk::linsys::impl Namespace Reference

Implementation Details -- not generally of interest for the public API. More...

Functions

int map_field_to_int (FieldIdMap &field_id_map, const stk::mesh::FieldBase &field)
 Given a map and a Field, return the int id that the field is mapped to.
int query_field_to_int_mapping (const FieldIdMap &field_id_map, const stk::mesh::FieldBase &field)
 Given a map and a Field, return the int id that the field is mapped to.
const stk::mesh::FieldBaseget_field (const FieldIdMap &field_id_map, int field_id)
 Given an integer field_id, return a reference to the corresponding field.
int entitytype_to_int (stk::mesh::EntityRank entity_rank)
 Given an EntityRank, return the value as an int.
int entityid_to_int (stk::mesh::EntityId id)
 Given an EntityId, return the value as an int.
template<typename T >
void verify_convertible_to_int (T id, const char *caller)
 Determine whether 'id' can be converted to an int.

Detailed Description

Implementation Details -- not generally of interest for the public API.


Function Documentation

int stk::linsys::impl::map_field_to_int ( FieldIdMap &  field_id_map,
const stk::mesh::FieldBase field 
)

Given a map and a Field, return the int id that the field is mapped to.

The field will be added to the map if not already present. This is useful because FEI classes/functions use integer ids for fields.

int stk::linsys::impl::query_field_to_int_mapping ( const FieldIdMap &  field_id_map,
const stk::mesh::FieldBase field 
)

Given a map and a Field, return the int id that the field is mapped to.

If the field is not found in the map, an exception is thrown. This is useful because FEI classes/functions use integer ids for fields.

const stk::mesh::FieldBase * stk::linsys::impl::get_field ( const FieldIdMap &  field_id_map,
int  field_id 
)

Given an integer field_id, return a reference to the corresponding field.

Throw an exception if field_id not found.

int stk::linsys::impl::entitytype_to_int ( stk::mesh::EntityRank  entity_rank  ) 

Given an EntityRank, return the value as an int.

Throws an exception if id is too large to represent as an int. This is useful because FEI classes/functions use integer ids for entity-types.

int stk::linsys::impl::entityid_to_int ( stk::mesh::EntityId  id  ) 

Given an EntityId, return the value as an int.

Throws an exception if id is too large to represent as an int. This is useful because FEI classes/functions use integer ids for entities.

template<typename T >
void stk::linsys::impl::verify_convertible_to_int ( id,
const char *  caller 
) [inline]

Determine whether 'id' can be converted to an int.

If so, do nothing. If 'id' is too large to be represented as an int, throw an exception (std::runtime_error).

Definition at line 67 of file ImplDetails.hpp.

Generated on Wed Apr 13 10:05:50 2011 for Sierra Toolkit by  doxygen 1.6.3