RefVolume.hpp

Go to the documentation of this file.

//-------------------------------------------------------------------------
// Filename      : RefVolume.hpp 
//
// Purpose       : This file contains the declarations of the class 
//                 RefVolume.
//
// Special Notes : 
//
// Creator       : Malcolm J. Panthaki
//
// Creation Date : 07/11/96
//
// Owner         : Malcolm J. Panthaki
//-------------------------------------------------------------------------

#ifndef REFVOLUME_HPP
#define REFVOLUME_HPP

// ********** BEGIN STANDARD INCLUDES      **********
// ********** END STANDARD INCLUDES        **********

// ********** BEGIN MOTIF INCLUDES         **********
// ********** END MOTIF INCLUDES           **********

// ********** BEGIN OPEN INVENTOR INCLUDES **********
// ********** END OPEN INVENTOR INCLUDES   **********

// ********** BEGIN CUBIT INCLUDES         **********

#include "CastTo.hpp"
#include "BasicTopologyEntity.hpp"
#include "Lump.hpp"
// lists
#include "DLIList.hpp"
// ********** END CUBIT INCLUDES           **********

// ********** BEGIN MACRO DEFINITIONS      **********
// ********** END MACRO DEFINITIONS        **********

// ********** BEGIN ENUM DECLARATIONS      **********
// ********** END ENUM DECLARATIONS        **********

// ********** BEGIN FORWARD DECLARATIONS   **********

// ********** END FORWARD DECLARATIONS     **********

class CUBIT_GEOM_EXPORT RefVolume : public BasicTopologyEntity
{
public :
  
  typedef RefFace ChildType;
  typedef Body ParentType;

  friend class RefEntityFactory;
    //- the factory is allowed to call the (private) constructors

    /* constructors/destructors */

  virtual ~RefVolume() ;
    //- The destructor

    /* topology */

  DagType dag_type() const { return DagType::ref_volume_type(); }  

  const std::type_info& entity_type_info() const { return typeid(RefVolume); }

  void get_parent_ref_entities(DLIList<RefEntity*>& entity_list);

  static const char* get_class_name()
  {
    return "Volume";
  }

  virtual const char* class_name() const
  {
    return get_class_name();
  }
  
  Lump* get_lump_ptr() ;

  Lump const* get_lump_ptr() const ;

  Body* get_body_ptr() ;

  int num_boundary_components();

  CubitBoolean about_spatially_equal ( RefVolume* ref_vol_ptr_2,
                                       double tolerance_factor);

  int genus();

    /* geometry */

  virtual CubitVector center_point();
  
  CubitBoolean is_sheet();
  
//**********Graphics Related Functions**********//

  virtual int dimension() const; 

    /* other functions */

  virtual CubitString measure_label();


  CubitStatus mass_properties( CubitVector &centroid, double &volume );
  CubitStatus mass_properties( CubitVector principal_axes[3], 
                               CubitVector &principal_moments, 
                               CubitVector &centroid, 
                               double &volume );

  int validate();

protected:

  RefVolume(Lump* lumpPtr) ;
    //- The constructor with a pointer to a Lump.

private:

   void initialize();
   //- Initializes all the member data


  RefVolume( const RefVolume& );
  void operator=( const RefVolume& );
};

template <> struct DLIListSorter<RefVolume*>
{
  bool operator()(RefVolume* a, RefVolume* b) { return a->id() < b->id(); }
};

#endif