Public Member Functions | Private Attributes | List of all members
oomph::TetMeshFacet Class Reference

///////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////// More...

#include <tet_mesh.h>

Public Member Functions

 TetMeshFacet (const unsigned &nvertex)
 Constructor: Specify number of vertices. More...
 
unsigned nvertex () const
 Number of vertices. More...
 
TetMeshVertex * vertex_pt (const unsigned &j) const
 Pointer to j-th vertex (const) More...
 
void set_vertex_pt (const unsigned &j, TetMeshVertex *vertex_pt)
 Set pointer to j-th vertex and pass one-based boundary id that may already have been set for this facet. More...
 
unsigned one_based_boundary_id () const
 Constant access to (one-based!) boundary IDs this facet lives on. More...
 
void set_one_based_boundary_id (const unsigned &one_based_id)
 Set (one-based!) boundary IDs this facet lives on. Passed to any existing vertices and to any future ones. More...
 
void set_one_based_adjacent_region_id (const unsigned &one_based_id)
 Set (one-based!) region ID this facet is adjacent to. Specification of zero argument is harmless as it indicates that that facet is not adjacent to any region. More...
 
std::set< unsigned > one_based_adjacent_region_id () const
 Return set of (one-based!) region IDs this facet is adjacent to. More...
 
bool facet_is_embedded_in_a_specified_region ()
 Boolean indicating that facet is embedded in a specified region. More...
 
void set_one_based_region_that_facet_is_embedded_in (const unsigned &one_based_region_id)
 Facet is to be embedded in specified one-based region. More...
 
unsigned one_based_region_that_facet_is_embedded_in ()
 Which (one-based) region is facet embedded in (if zero, it's not embedded in any region) More...
 
void output (std::ostream &outfile) const
 Output. More...
 

Private Attributes

Vector< TetMeshVertex * > Vertex_pt
 Pointer to vertices. More...
 
unsigned One_based_boundary_id
 (One-based!) boundary IDs this facet lives on More...
 
std::set< unsigned > One_based_adjacent_region_id
 Set of one-based adjacent region ids; no adjacent region if it's zero. More...
 
unsigned One_based_region_id_that_facet_is_embedded_in
 Facet is to be embedded in specified one-based region. Defaults to zero, indicating that its not embedded. More...
 

Detailed Description

///////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////

Facet for Tet mesh generation. Can lie on boundary (identified via one-based enumeration!) and can have GeomObject associated with those boundaries.

Definition at line 167 of file tet_mesh.h.

Constructor & Destructor Documentation

◆ TetMeshFacet()

oomph::TetMeshFacet::TetMeshFacet ( const unsigned &  nvertex)
inline

Constructor: Specify number of vertices.

Definition at line 171 of file tet_mesh.h.

References nvertex(), and Vertex_pt.

Member Function Documentation

◆ facet_is_embedded_in_a_specified_region()

bool oomph::TetMeshFacet::facet_is_embedded_in_a_specified_region ( )
inline

Boolean indicating that facet is embedded in a specified region.

Definition at line 243 of file tet_mesh.h.

References One_based_region_id_that_facet_is_embedded_in.

Referenced by oomph::GmshTetScaffoldMesh::write_geo_file().

◆ nvertex()

unsigned oomph::TetMeshFacet::nvertex ( ) const
inline

Number of vertices.

Definition at line 181 of file tet_mesh.h.

References Vertex_pt.

Referenced by oomph::TetMeshBase::setup_boundary_coordinates(), oomph::TetMeshBase::snap_nodes_onto_geometric_objects(), TetMeshFacet(), and oomph::GmshTetScaffoldMesh::write_geo_file().

◆ one_based_adjacent_region_id()

std::set<unsigned> oomph::TetMeshFacet::one_based_adjacent_region_id ( ) const
inline

Return set of (one-based!) region IDs this facet is adjacent to.

Definition at line 237 of file tet_mesh.h.

References One_based_adjacent_region_id.

Referenced by oomph::GmshTetScaffoldMesh::write_geo_file().

◆ one_based_boundary_id()

unsigned oomph::TetMeshFacet::one_based_boundary_id ( ) const
inline

Constant access to (one-based!) boundary IDs this facet lives on.

Definition at line 207 of file tet_mesh.h.

References One_based_boundary_id.

◆ one_based_region_that_facet_is_embedded_in()

unsigned oomph::TetMeshFacet::one_based_region_that_facet_is_embedded_in ( )
inline

Which (one-based) region is facet embedded in (if zero, it's not embedded in any region)

Definition at line 257 of file tet_mesh.h.

References One_based_region_id_that_facet_is_embedded_in.

Referenced by oomph::GmshTetScaffoldMesh::write_geo_file().

◆ output()

void oomph::TetMeshFacet::output ( std::ostream &  outfile) const
inline

Output.

Definition at line 263 of file tet_mesh.h.

References One_based_boundary_id, and Vertex_pt.

◆ set_one_based_adjacent_region_id()

void oomph::TetMeshFacet::set_one_based_adjacent_region_id ( const unsigned &  one_based_id)
inline

Set (one-based!) region ID this facet is adjacent to. Specification of zero argument is harmless as it indicates that that facet is not adjacent to any region.

Definition at line 231 of file tet_mesh.h.

References One_based_adjacent_region_id.

◆ set_one_based_boundary_id()

void oomph::TetMeshFacet::set_one_based_boundary_id ( const unsigned &  one_based_id)
inline

Set (one-based!) boundary IDs this facet lives on. Passed to any existing vertices and to any future ones.

Definition at line 214 of file tet_mesh.h.

References One_based_boundary_id, oomph::TetMeshVertex::set_one_based_boundary_id(), and Vertex_pt.

◆ set_one_based_region_that_facet_is_embedded_in()

void oomph::TetMeshFacet::set_one_based_region_that_facet_is_embedded_in ( const unsigned &  one_based_region_id)
inline

Facet is to be embedded in specified one-based region.

Definition at line 249 of file tet_mesh.h.

References One_based_region_id_that_facet_is_embedded_in.

◆ set_vertex_pt()

void oomph::TetMeshFacet::set_vertex_pt ( const unsigned &  j,
TetMeshVertex *  vertex_pt 
)
inline

Set pointer to j-th vertex and pass one-based boundary id that may already have been set for this facet.

Definition at line 194 of file tet_mesh.h.

References One_based_boundary_id, oomph::TetMeshVertex::set_one_based_boundary_id(), vertex_pt(), and Vertex_pt.

◆ vertex_pt()

TetMeshVertex* oomph::TetMeshFacet::vertex_pt ( const unsigned &  j) const
inline

Pointer to j-th vertex (const)

Definition at line 187 of file tet_mesh.h.

References Vertex_pt.

Referenced by set_vertex_pt(), oomph::TetMeshBase::setup_boundary_coordinates(), oomph::TetMeshBase::snap_nodes_onto_geometric_objects(), and oomph::GmshTetScaffoldMesh::write_geo_file().

Member Data Documentation

◆ One_based_adjacent_region_id

std::set<unsigned> oomph::TetMeshFacet::One_based_adjacent_region_id
private

Set of one-based adjacent region ids; no adjacent region if it's zero.

Definition at line 287 of file tet_mesh.h.

Referenced by one_based_adjacent_region_id(), and set_one_based_adjacent_region_id().

◆ One_based_boundary_id

unsigned oomph::TetMeshFacet::One_based_boundary_id
private

(One-based!) boundary IDs this facet lives on

Definition at line 283 of file tet_mesh.h.

Referenced by one_based_boundary_id(), output(), set_one_based_boundary_id(), and set_vertex_pt().

◆ One_based_region_id_that_facet_is_embedded_in

unsigned oomph::TetMeshFacet::One_based_region_id_that_facet_is_embedded_in
private

Facet is to be embedded in specified one-based region. Defaults to zero, indicating that its not embedded.

Definition at line 292 of file tet_mesh.h.

Referenced by facet_is_embedded_in_a_specified_region(), one_based_region_that_facet_is_embedded_in(), and set_one_based_region_that_facet_is_embedded_in().

◆ Vertex_pt

Vector<TetMeshVertex*> oomph::TetMeshFacet::Vertex_pt
private

Pointer to vertices.

Definition at line 280 of file tet_mesh.h.

Referenced by nvertex(), output(), set_one_based_boundary_id(), set_vertex_pt(), TetMeshFacet(), and vertex_pt().

The documentation for this class was generated from the following file: