Defines a volume object that mostly parallels Cubit's RefVolume class. More...

#include <CubitInterfaceEx.hpp>

Inheritance diagram for Volume:

Public Member Functions
	Volume ()

	Volume (const Volume &other)

	Volume (CubitEntity *entity_ptr)

	~Volume ()

std::array< double, 3 >	centroid ()
	Get the centroid of the Volume.

std::array< double, 4 >	color ()
	Get the color of the Volume.

std::array< double, 9 >	principal_axes ()
	Get the principal axes of the Volume.

std::array< double, 3 >	principal_moments ()
	Get the principal moments of the Volume.

void	set_color (std::array< double, 4 > value)
	Set the color of the Volume.

double	volume ()
	Get the volume of the Volume.

Public Member Functions inherited from GeomEntity
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.

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.

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	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.

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.

Entity &	operator= (const Entity &rhs)

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 volume object that mostly parallels Cubit's RefVolume class.

Constructor & Destructor Documentation

◆ Volume() [1/3]

Volume ( )

inline

◆ ~Volume()

~Volume ( )

inline

◆ Volume() [2/3]

Volume ( const Volume & other )

inline

◆ Volume() [3/3]

Volume ( CubitEntity * entity_ptr )

inline

Member Function Documentation

◆ centroid()

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

Get the centroid of the Volume .

std::array<double,3> centroid = volume ->centroid();

CubitInterface::Volume::volume

double volume()

Get the volume of the Volume.

CubitInterface::Volume::centroid

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

Get the centroid of the Volume.

centroid = volume .centroid()

Returns: A vector (or list) of the coordinates of the centroid of the volume with the indices of the vector corresponding to the values as follows:
0 - x coordinate
1 - y coordinate
2 - z coordinate

◆ color()

std::array< double, 4 > color ( )

Get the color of the Volume .

int col = volume ->color();

col = volume .color()

Returns: The color value associated with the volume's current color

◆ principal_axes()

std::array< double, 9 > principal_axes ( )

Get the principal axes of the Volume .

std::array<double,9> axes = volume ->principal_axes();

axes = volume .principal_axes()

Returns: A vector (or list) of the principal axes of the volume with the indices of the vector corresponding to the values as follows:
0 - axis 1 x value
1 - axis 1 y value
2 - axis 1 z value
3 - axis 2 x value
4 - axis 2 y value
5 - axis 2 z value
6 - axis 3 x value
7 - axis 3 y value
8 - axis 3 z value

◆ principal_moments()

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

Get the principal moments of the Volume .

std::array<double,3> moments = volume ->principal_moments();

moments = volume .principal_moments()

Returns: A vector (or list) of the principal moments of the volume with the indices of the vector corresponding to the values as follows:
0 - x moment
1 - y moment
2 - z moment

◆ set_color()

void set_color ( std::array< double, 4 > value )

Set the color of the Volume .

volume ->set_color(0);

volume .set_color(0)

Parameters

[in] value The color value that the volume will have

◆ volume()

double volume ( )

Get the volume of the Volume .

double vol = volume ->volume();

vol = volume .volume()

Returns: The volume of the Volume

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Volume() [1/3]

◆ ~Volume()

◆ Volume() [2/3]

◆ Volume() [3/3]

Member Function Documentation

◆ centroid()

◆ color()

◆ principal_axes()

◆ principal_moments()

◆ set_color()

◆ volume()