Coreform Cubit 2024.3 User Documentation
Click here to see this page in full context

Coreform Cubit 2024.3 User Documentation

Cubit Python API 2024.3
Public Member Functions | Protected Member Functions
GeomEntity

The base class for specifically the Geometry types (Body , Surface , etc.) More...

#include <CubitInterfaceEx.hpp>

Inheritance diagram for GeomEntity:
Entity Body Curve Surface Vertex Volume

Public Member Functions
std::vector< Body > bodies ()
  Get the bodies in the GeomEntity.
 
std::vector< Curve > curves ()
  Get the curves in the GeomEntity.
 
int dimension ()
  Get the dimensions of the GeomEntity.
 
std::string entity_name ()
  Return the first name of the GeomEntity.
 
void entity_name (std::string name)
  Assign a name to the GeomEntity.
 
std::vector< std::string > entity_names ()
  Return the all the names of the GeomEntity.
 
bool is_meshed ()
  Return the current mesh state of the GeomEntity.
 
void mesh ()
  Mesh the GeomEntity.
 
int num_names ()
  Return the number of names for the GeomEntity.
 
void remove_entity_name (std::string name)
  Remove a specific name from the list of names assigned to the GeomEntity.
 
void remove_entity_names ()
  Remove all the names assigned to the GeomEntity.
 
void remove_mesh ()
  Removes the mesh on the GeomEntity.
 
void set_entity_name (std::string name)
  Assign a name to the GeomEntity.
 
void smooth ()
  Smooths the mesh on the GeomEntity.
 
std::vector< Surface > surfaces ()
  Get the surfaces in the GeomEntity.
 
std::vector< Vertex > vertices ()
  Get the vertices in the GeomEntity.
 
std::vector< Volume > volumes ()
  Get the volumes in the GeomEntity.
 
- 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.
 
std::array< double, 3 > center_point ()
  Get the center point of the Entity.
 
void destroy_ Cubit_entity ()
 
CubitEntity * entity_ptr ()
 
int id ()
  Get the id of the Entity.
 
int is_transparent ()
  Get the tranparency state of the Entity.
 
void is_transparent (int transparency_flag)
  Set the tranparency state of the Entity.
 
int is_visible ()
  Get the visibility state of the Entity.
 
void is_visible (bool visibility_flag)
  Set the visibility state of the Entity.
 
Entity & operator= (const Entity &rhs)
 
void set_transparent (int transparency_flag)
  Set the tranparency state of the Entity.
 
void set_visible (bool visibility_flag)
  Set the visibility state of the Entity.
 

Protected Member Functions
  GeomEntity (const GeomEntity &other)
 
  GeomEntity (CubitEntity *entity_ptr)
 

Additional Inherited Members
- Protected Attributes inherited from Entity
CubObserver * CubitWatcher
 
CubitEntity * mEntityPtr
 

Detailed Description

The base class for specifically the Geometry types (Body , Surface , etc.)

Constructor & Destructor Documentation

◆ GeomEntity() [1/2]

GeomEntity ( CubitEntity * entity_ptr )  
inlineprotected
 

◆ GeomEntity() [2/2]

GeomEntity ( const GeomEntity & other )  
inlineprotected
 

Member Function Documentation

◆ bodies()

std::vector< Body > bodies (   )  

Get the bodies in the GeomEntity .

std::vector<Body> bodies = geomEntity->bodies();
CubitInterface::GeomEntity::bodies
std::vector< Body > bodies()
Get the bodies in the GeomEntity.
bodies = geomEntity.bodies()
Returns
A vector (or list) of bodies contained within the GeomEntity

◆ curves()

std::vector< Curve > curves (   )  

Get the curves in the GeomEntity .

std::vector<Curve> curves = geomEntity->curves();
CubitInterface::GeomEntity::curves
std::vector< Curve > curves()
Get the curves in the GeomEntity.
curves = geomEntity.curves()
Returns
A vector (or list) of curves contained within the GeomEntity

◆ dimension()

int dimension (   )  

Get the dimensions of the GeomEntity .

int dim = geomEntity->dimension();
dim = geomEntity.dimension()
Returns
The dimension of the GeomEntity

◆ entity_name() [1/2]

std::string entity_name (   )  

Return the first name of the GeomEntity .

std::string name = geomEntity->entity_name();
name = geomEntity.entity_name()
Returns
The first name of the GeomEntity

◆ entity_name() [2/2]

void entity_name ( std::string name )  

Assign a name to the GeomEntity .

geomEntity->entity_name("Brick1" );
geomEntity.entity_name("Brick1" )
Parameters
[in] name The name to be assigned to the GeomEntity

◆ entity_names()

std::vector< std::string > entity_names (   )  

Return the all the names of the GeomEntity .

std::vector<std::string> names = geomEntity->entity_names();
names = geomEntity.entity_names()
Returns
A vector (or list) of all the names of the GeomEntity

◆ is_meshed()

bool is_meshed (   )  

Return the current mesh state of the GeomEntity .

boolmesh = geomEntity->is_meshed();
CubitInterface::GeomEntity::mesh
void mesh()
Mesh the GeomEntity.
mesh = geomEntity.is_meshed()
Returns
Whether the GeomEntity is meshed or not

◆ mesh()

void mesh (   )  

Mesh the GeomEntity .

geomEntity->mesh();
geomEntity.mesh()

◆ num_names()

int num_names (   )  

Return the number of names for the GeomEntity .

int num = geomEntity->num_names();
num = geomEntity.num_names()
Returns
The number of names for the GeomEntity

◆ remove_entity_name()

void remove_entity_name ( std::string name )  

Remove a specific name from the list of names assigned to the GeomEntity .

geomEntity->remove_entity_name("Brick1" );
geomEntity.remove_entity_name("Brick1" )
Parameters
[in] name The name to be removed from the list of names assigned to the GeomEntity

◆ remove_entity_names()

void remove_entity_names (   )  

Remove all the names assigned to the GeomEntity .

geomEntity->remove_entity_names();
geomEntity.remove_entity_names()

◆ remove_mesh()

void remove_mesh (   )  

Removes the mesh on the GeomEntity .

geomEntity->remove_mesh();
geomEntity.remove_mesh()

◆ set_entity_name()

void set_entity_name ( std::string name )  

Assign a name to the GeomEntity .

geomEntity->set_entity_name("Brick1" );
geomEntity.set_entity_name("Brick1" )
Parameters
[in] name The name to be assigned to the GeomEntity

◆ smooth()

void smooth (   )  

Smooths the mesh on the GeomEntity .

geomEntity->smooth();
geomEntity.smooth()

◆ surfaces()

std::vector< Surface > surfaces (   )  

Get the surfaces in the GeomEntity .

std::vector<Surface> surfaces = geomEntity->surfaces();
CubitInterface::GeomEntity::surfaces
std::vector< Surface > surfaces()
Get the surfaces in the GeomEntity.
surfaces = geomEntity.surfaces()
Returns
A vector (or list) of surfaces contained within the GeomEntity

◆ vertices()

std::vector< Vertex > vertices (   )  

Get the vertices in the GeomEntity .

std::vector<Vertex> vertices = geomEntity->vertices();
CubitInterface::GeomEntity::vertices
std::vector< Vertex > vertices()
Get the vertices in the GeomEntity.
vertices = geomEntity.vertices()
Returns
A vector (or list) of vertices contained within the GeomEntity

◆ volumes()

std::vector< Volume > volumes (   )  

Get the volumes in the GeomEntity .

std::vector<Volume> volumes = geomEntity->volumes();
CubitInterface::GeomEntity::volumes
std::vector< Volume > volumes()
Get the volumes in the GeomEntity.
volumes = geomEntity.volumes()
Returns
A vector (or list) of volumes contained within the GeomEntity