Types.hpp

/*------------------------------------------------------------------------*/
/*                 Copyright 2010 Sandia Corporation.                     */
/*  Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive   */
/*  license for use of this work by or on behalf of the U.S. Government.  */
/*  Export of this program may require a license from the                 */
/*  United States Government.                                             */
/*------------------------------------------------------------------------*/

#ifndef stk_mesh_Types_hpp
#define stk_mesh_Types_hpp

//----------------------------------------------------------------------

#include <stdint.h>
#include <limits>
#include <utility>
#include <vector>

#include <stk_util/util/PairIter.hpp>
#include <stk_util/util/NamedPair.hpp>

namespace stk {
namespace mesh {

//----------------------------------------------------------------------
class MetaData ;  // Meta-data description of a mesh
class Part ;      // Defined subset of the mesh

typedef std::vector< Part * > PartVector ;

class FieldBase;

template< typename Scalar = void ,
          class Tag1 = void , class Tag2 = void ,
          class Tag3 = void , class Tag4 = void ,
          class Tag5 = void , class Tag6 = void ,
          class Tag7 = void >
  class Field ;

enum { MaximumFieldDimension = 7 };

template< typename DataType = void > class Property ;

typedef Property< void > PropertyBase ;

//----------------------------------------------------------------------
class BulkData ; // Bulk-data of a mesh
class Bucket ;   // Homogeneous collection of mesh entitities their field data
class Entity ;   // Individual entity within the mesh
class Relation ; // Relation pair of local mesh entities
class Ghosting ;

typedef std::vector<Entity *> EntityVector;

enum EntityModificationLog { EntityLogNoChange = 0 ,
                             EntityLogCreated  = 1 ,
                             EntityLogModified = 2 ,
                             EntityLogDeleted  = 3 };

template< class FieldType > struct EntityArray ;
template< class FieldType > struct BucketArray ;
template< class FieldType > struct FieldTraits ;


typedef unsigned EntityRank ;
typedef uint64_t EntityId ;

// Base Entity Rank 
// Note:  This BaseEntityRank can be considered the leaf of a tree and it
// represents the furthest out you can go in downward relations.
enum { BaseEntityRank = EntityRank(0) };


typedef unsigned Ordinal;
typedef Ordinal PartOrdinal;
typedef Ordinal FieldOrdinal;

//----------------------------------------------------------------------
typedef std::pair<Entity*,unsigned> EntityProc ;

typedef PairIter< std::vector< EntityProc >::const_iterator >
  PairIterEntityProc ;

NAMED_PAIR( EntityCommInfo , unsigned , ghost_id , unsigned , proc )


typedef PairIter< std::vector< EntityCommInfo >::const_iterator >
  PairIterEntityComm ;

typedef std::vector<EntityCommInfo> EntityCommInfoVector;

//----------------------------------------------------------------------
typedef int ( * relation_stencil_ptr )( unsigned  from_type ,
                                        unsigned  to_type ,
                                        unsigned  identifier );

//----------------------------------------------------------------------
typedef PairIter< std::vector<Relation>::const_iterator > PairIterRelation ;
typedef std::vector<Relation> RelationVector;

//----------------------------------------------------------------------


} // namespace mesh
} // namespace stk

//----------------------------------------------------------------------

namespace stk {
namespace mesh {

class UnitTestMetaData ;
class UnitTestBulkData ;

} // namespace mesh
} // namespace stk

#endif