Chi-Tech
Public Member Functions | Static Public Member Functions | Data Fields
chi_mesh::CellFace Class Reference

#include <cell.h>

Public Member Functions

bool IsNeighborLocal (const chi_mesh::MeshContinuum &grid) const
 
int GetNeighborPartitionID (const chi_mesh::MeshContinuum &grid) const
 
uint64_t GetNeighborLocalID (const chi_mesh::MeshContinuum &grid) const
 
int GetNeighborAssociatedFace (const chi_mesh::MeshContinuum &grid) const
 
double ComputeFaceArea (const chi_mesh::MeshContinuum &grid) const
 
chi_data_types::ByteArray Serialize () const
 
std::string ToString () const
 
void RecomputeCentroid (const chi_mesh::MeshContinuum &grid)
 

Static Public Member Functions

static CellFace DeSerialize (const chi_data_types::ByteArray &raw, size_t &address)
 

Data Fields

std::vector< uint64_t > vertex_ids_
 
Normal normal_
 A list of the vertices. More...
 
Vertex centroid_
 The face centroid. More...
 
bool has_neighbor_ =false
 Flag indicating whether face has a neighbor. More...
 
uint64_t neighbor_id_ =0
 Otherwise contains boundary_id. More...
 

Detailed Description

In this paradigm a face is an object which largely is considered to be planar (meaning all the vertices lay in the same plane).

Definition at line 35 of file cell.h.

Member Function Documentation

◆ ComputeFaceArea()

double chi_mesh::CellFace::ComputeFaceArea ( const chi_mesh::MeshContinuum &  grid) const

Computes the face area.

Definition at line 183 of file cell.cc.

◆ DeSerialize()

chi_mesh::CellFace chi_mesh::CellFace::DeSerialize ( const chi_data_types::ByteArray &  raw,
size_t &  address 
)
static

Deserializes a face from a set of raw data

Definition at line 243 of file cell.cc.

◆ GetNeighborAssociatedFace()

int chi_mesh::CellFace::GetNeighborAssociatedFace ( const chi_mesh::MeshContinuum &  grid) const

Determines the neighbor's associated face.

Definition at line 127 of file cell.cc.

◆ GetNeighborLocalID()

uint64_t chi_mesh::CellFace::GetNeighborLocalID ( const chi_mesh::MeshContinuum &  grid) const

Determines the neighbor's local id.

Definition at line 111 of file cell.cc.

◆ GetNeighborPartitionID()

int chi_mesh::CellFace::GetNeighborPartitionID ( const chi_mesh::MeshContinuum &  grid) const

Determines the neighbor's partition.

Definition at line 98 of file cell.cc.

◆ IsNeighborLocal()

bool chi_mesh::CellFace::IsNeighborLocal ( const chi_mesh::MeshContinuum &  grid) const

Determines the neighbor's partition and whether its local or not.

Definition at line 85 of file cell.cc.

◆ RecomputeCentroid()

void chi_mesh::CellFace::RecomputeCentroid ( const chi_mesh::MeshContinuum &  grid)

Recomputes the face centroid assuming the mesh vertices have been transformed.

Definition at line 289 of file cell.cc.

◆ Serialize()

chi_data_types::ByteArray chi_mesh::CellFace::Serialize ( ) const

Serializes a face into a vector of bytes.

Definition at line 225 of file cell.cc.

◆ ToString()

std::string chi_mesh::CellFace::ToString ( ) const

Provides string information of the face.

Definition at line 266 of file cell.cc.

Field Documentation

◆ centroid_

Vertex chi_mesh::CellFace::centroid_

The face centroid.

Definition at line 40 of file cell.h.

◆ has_neighbor_

bool chi_mesh::CellFace::has_neighbor_ =false

Flag indicating whether face has a neighbor.

Definition at line 41 of file cell.h.

◆ neighbor_id_

uint64_t chi_mesh::CellFace::neighbor_id_ =0

Otherwise contains boundary_id.

If face has neighbor, contains the global_id.

Definition at line 42 of file cell.h.

◆ normal_

Normal chi_mesh::CellFace::normal_

A list of the vertices.

The average/geometric normal

Definition at line 39 of file cell.h.

◆ vertex_ids_

std::vector<uint64_t> chi_mesh::CellFace::vertex_ids_

Definition at line 38 of file cell.h.

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