TopologicalMetaData.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_TopologicalMetaData_hpp
#define stk_mesh_TopologicalMetaData_hpp

#include <Shards_CellTopologyData.h>
#include <Shards_BasicTopologies.hpp>
#include <stk_mesh/base/MetaData.hpp>
#include <stk_mesh/fem/FEMTypes.hpp>

namespace stk {
namespace mesh {


//----------------------------------------------------------------------------
//----------------------------------------------------------------------------
class TopologicalMetaData {
public:
  //--------------------------------------------------------------------------

  static void verify_spatial_dimension( unsigned spatial_dimension ,
                                        const char * method );

  static std::vector<std::string> entity_rank_names( unsigned spatial_dimension );

  TopologicalMetaData( MetaData & , unsigned spatial_dimension );

  ~TopologicalMetaData();

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

  const unsigned spatial_dimension ; 

  const EntityRank node_rank ;    
  const EntityRank edge_rank ;    
  const EntityRank side_rank ;    
  const EntityRank element_rank ; 
  const EntityRank patch_rank ;   

  //--------------------------------------------------------------------------
  static const CellTopologyData * get_cell_topology( const Part & part , const char * required_by = 0 );

  static const CellTopologyData * get_cell_topology( const Bucket & bucket , const char * required_by = 0 );
  static const CellTopologyData * get_cell_topology( const Entity & entity , const char * required_by = 0 );

  //--------------------------------------------------------------------------
  Part & declare_part( const std::string & name ,
                       const CellTopologyData * top );

  template< class Top >
  Part & declare_part( const std::string & name )
    { return declare_part( name , shards::getCellTopologyData<Top>() ); }

  //--------------------------------------------------------------------------
  void declare_cell_topology( const CellTopologyData * , EntityRank entity_rank );

  //throws if not found
  EntityRank get_entity_rank( const CellTopologyData * ) const ;

private:
 
  // Base meta data to which this topological meta data is attached.
  MetaData & m_meta_data ;

  // Defined cell topologies and associated mesh entity rank.
  std::vector< std::pair< const CellTopologyData * , EntityRank > > m_top_rank ;

  // Map part meta data ordinals to cell topologies.
  std::vector< std::pair< unsigned , const CellTopologyData * > > m_part_top_map ;

  static const TopologicalMetaData * internal_get( const MetaData & );

  const CellTopologyData * internal_get_cell_topology( unsigned part_ordinal) const ;

  void internal_set_entity_rank( const CellTopologyData * , EntityRank );
  
  // Set sell topology internally, to be used only from declare_part
  void internal_set_cell_topology( 
      Part & part, 
      unsigned entity_rank, 
      const CellTopologyData * top
      );


  void throw_ambiguous( const Part & ) const ;
  void throw_ambiguous( const Bucket & ) const ;
  static void throw_required( const Part & , const char * );
  static void throw_required( const Bucket & , const char * );


  TopologicalMetaData();
  TopologicalMetaData( const TopologicalMetaData & );
  TopologicalMetaData & operator = ( const TopologicalMetaData & );
};

}
}

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

#endif