Cubit Python API  16.06
Public Member Functions
Body

Defines a body object that mostly parallels Cubit's Body class. More...

Inheritance diagram for Body:
GeomEntity Entity

Public Member Functions
  Body ()
 
  Body (const Body &other)
 
  Body (CubitEntity *entity_ptr)
 
  ~Body ()
 
std::array< double, 3 >  get_mass_props ()
  Get the mass properties of the Body, specifically the center of gravity. More...
 
bool  is_sheet_body ()
  Get whether the Body is a sheet body or not. More...
 
int  point_containment (std::array< double, 3 > loc_in)
  Get whether a point is in, on, or outside the Body. More...
 
double  volume ()
  Get the volume of the Body. More...
 
- Public Member Functions inherited from GeomEntity
std::vector< Body >  bodies ()
  Get the bodies in the GeomEntity. More...
 
std::vector< Curve >  curves ()
  Get the curves in the GeomEntity. More...
 
int  dimension ()
  Get the dimensions of the GeomEntity. More...
 
std::string  entity_name ()
  Return the first name of the GeomEntity. More...
 
void  entity_name (std::string name)
  Assign a name to the GeomEntity. More...
 
std::vector< std::string >  entity_names ()
  Return the all the names of the GeomEntity. More...
 
bool  is_meshed ()
  Return the current mesh state of the GeomEntity. More...
 
void  mesh ()
  Mesh the GeomEntity. More...
 
int  num_names ()
  Return the number of names for the GeomEntity. More...
 
void  remove_entity_name (std::string name)
  Remove a specific name from the list of names assigned to the GeomEntity. More...
 
void  remove_entity_names ()
  Remove all the names assigned to the GeomEntity. More...
 
void  remove_mesh ()
  Removes the mesh on the GeomEntity. More...
 
void  set_entity_name (std::string name)
  Assign a name to the GeomEntity. More...
 
void  smooth ()
  Smooths the mesh on the GeomEntity. More...
 
std::vector< Surface >  surfaces ()
  Get the surfaces in the GeomEntity. More...
 
std::vector< Vertex >  vertices ()
  Get the vertices in the GeomEntity. More...
 
std::vector< Volume >  volumes ()
  Get the volumes in the GeomEntity. More...
 
- Public Member Functions inherited from Entity
  Entity ()
 
  Entity (CubitEntity *entity_ptr)
 
  Entity (Entity const &copy_from)
 
  ~Entity ()
 
std::array< double, 6 >  bounding_box ()
  Get the bounding box of the Entity. More...
 
std::array< double, 3 >  center_point ()
  Get the center point of the Entity. More...
 
void  destroy_cubit_entity ()
 
CubitEntity *  entity_ptr ()
 
int  id ()
  Get the id of the Entity. More...
 
int  is_transparent ()
  Get the tranparency state of the Entity. More...
 
void  is_transparent (int transparency_flag)
  Set the tranparency state of the Entity. More...
 
int  is_visible ()
  Get the visibility state of the Entity. More...
 
void  is_visible (bool visibility_flag)
  Set the visibility state of the Entity. More...
 
Entity &  operator= (const Entity &rhs)
 
void  set_transparent (int transparency_flag)
  Set the tranparency state of the Entity. More...
 
void  set_visible (bool visibility_flag)
  Set the visibility state of the Entity. More...
 

Additional Inherited Members
- Protected Member Functions inherited from GeomEntity
  GeomEntity (const GeomEntity &other)
 
  GeomEntity (CubitEntity *entity_ptr)
 
- Protected Attributes inherited from Entity
CubObserver *  cubitWatcher
 
CubitEntity *  mEntityPtr
 

Detailed Description

Defines a body object that mostly parallels Cubit's Body class.

Constructor & Destructor Documentation

◆ Body() [1/3]

Body ( )
inline

◆ Body() [2/3]

Body ( const Body &  other )
inline

◆ ~Body()

~Body ( )
inline

◆ Body() [3/3]

Body ( CubitEntity *  entity_ptr )
inline

Member Function Documentation

◆ get_mass_props()

std::array<double,3> get_mass_props ( )

Get the mass properties of the Body , specifically the center of gravity.

std::array<double,3> props = body ->get_mass_props ();
props = body .get_mass_props ()
Returns
A vector (or list) of numerical data corresponding to the center of gravity of the body with indices as follows:
0 - x coordinate
1 - y coordinate
2 - z coordinate

◆ is_sheet_body()

bool is_sheet_body ( )

Get whether the Body is a sheet body or not.

bool is_sheet = body ->is_sheet_body ();
is_sheet = body .is_sheet_body ()
Returns
Whether the Body is a sheet body or not

◆ point_containment()

int point_containment ( std::array< double, 3 >  loc_in )

Get whether a point is in, on, or outside the Body .

std::array<double,3> point(3, 0);
int on_out_in = body ->point_containment (point);
on_out_in = body .point_containment ([0,0,0])
Returns
Whether a point is unknown (-1), outside (0), in (1), or on (2) the Body

◆ volume()

double volume ( )

Get the volume of the Body .

double vol = body ->volume ();
vol = body .volume ()
Returns
The volume of the Body