Sierra Toolkit Version of the Day
stk::rebalance::GeomDecomp Class Reference

Class for determining the optimal partitioning of mesh entities. More...

#include <GeomDecomp.hpp>

Inheritance diagram for stk::rebalance::GeomDecomp:
Collaboration diagram for stk::rebalance::GeomDecomp:

List of all members.

Public Types

typedef mesh::Field< double,
mesh::Cartesian
VectorField

Public Member Functions

 GeomDecomp (ParallelMachine comm)

Static Public Member Functions

static void entity_to_point (const mesh::Entity &entity, const VectorField &ref, std::vector< double > &coor)
 Convert a single mesh entity to a single point.
static std::vector< const
mesh::Entity * > 
entity_coordinates (const mesh::Entity &entity, const VectorField &ref, std::vector< std::vector< double > > &coordinates)
 Used to return the nodal entities that compute_entity_centroid averages.
static std::vector
< std::vector< double > > 
compute_entity_centroid (const mesh::Entity &entity, const VectorField &ref, std::vector< double > &coor)
 Returns a vector of vectors containing the coordinates of the nodes that were used to compute the centroid.
static bool confirm (const std::string &param_set_name)
 Check existence of library entry name on domain library. This is a simple one line convenience function.

Detailed Description

Class for determining the optimal partitioning of mesh entities.

Derived from the Partition class.

The GeomDecomp class has no data associated with it, only member functions. All data is inherited from the Partition class.

GeomDecomp has two functions. It adds functions to compute geometry information for mesh entities, such as the center point for a mesh entity. And it defines virtual functions to be specialized by other classes that interface to partitioning packages such as Zoltan.

Definition at line 71 of file GeomDecomp.hpp.


Member Function Documentation

void stk::rebalance::GeomDecomp::entity_to_point ( const mesh::Entity entity,
const VectorField ref,
std::vector< double > &  coor 
) [static]

Convert a single mesh entity to a single point.

Parameters:
entityEntity to take centroid of, element, side, face or node.
refCoordinate field to average, usually defined on the nodes.
coorIs the output coordinate and is assumed to be large enough to hold a single coordinate. Note the maximum needed in all cases is length 3.

The entity_to_point function is used in the case where a mesh entity is an element with many nodes. Then something like the element centroid can be used to define a single coordinate point for it.

Definition at line 133 of file GeomDecomp.cpp.

std::vector< const mesh::Entity * > stk::rebalance::GeomDecomp::entity_coordinates ( const mesh::Entity entity,
const VectorField ref,
std::vector< std::vector< double > > &  coordinates 
) [static]

Used to return the nodal entities that compute_entity_centroid averages.

Parameters:
entityEntity to take coordinates of, element, side, face or node.
refCoordinate field to average, usually defined on the nodes.
coorIs the output coordinates that entity_to_point would average to determine a centroid.

The return value is the mesh entities from which the coordinates were obtained.

Definition at line 34 of file GeomDecomp.cpp.

std::vector< std::vector< double > > stk::rebalance::GeomDecomp::compute_entity_centroid ( const mesh::Entity entity,
const VectorField ref,
std::vector< double > &  coor 
) [static]

Returns a vector of vectors containing the coordinates of the nodes that were used to compute the centroid.

Parameters:
entityEntity to take coordinates of, element, side, face or node.
refCoordinate field to average, usually defined on the nodes.
coorIs the output coordinated and is assumed to be large enough to hold a single coordinate. Note the maximum needed in all cases is length 3.

return value is the output coordinates that entity_to_point would average to determine a centroid.

Definition at line 70 of file GeomDecomp.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines