Tetrahedron Class Reference

#include <Tetrahedron.hpp>

Inheritance diagram for Tetrahedron:

[legend]

Collaboration diagram for Tetrahedron:

[legend]

List of all members.

Public Types
enum	{ NumberOfVertices = 4, NumberOfFaces = 4, NumberOfEdges = 6 }
typedef Triangle	FaceType
enum	Type {   hexahedron, cartesianHexahedron, hexahedronByEdge, tetrahedron,   triangle3d, quadrangle3d }
Public Member Functions
virtual Cell::Type	type () const
void	getBarycentricCoordinates (const TinyVector< 3, real_t > &X, TinyVector< 4, real_t > &lambda) const
size_t	numberOfVertices () const
	Number of Vertices.
size_t	numberOfEdges () const
	Number of Edges.
const Tetrahedron &	operator= (const Tetrahedron &T)
	sets equal to a given tetrahedron
	Tetrahedron ()
	Default constructor does nothing but reserving memory.
	Tetrahedron (Vertex &x0, Vertex &x1, Vertex &x2, Vertex &x3, const size_t &ref=0)
	~Tetrahedron ()
bool	find (const Vertex *P)
const real_t &	volume () const
void	replace (Vertex *v0, Vertex *v1)
const bool &	isFictitious () const
void	setFictitious (const bool &b) const
const size_t &	reference () const
size_t &	reference ()
Vertex &	operator() (const size_t &i)
const Vertex &	operator() (const size_t &i) const
Static Public Attributes
static const size_t	faces [NumberOfFaces][FaceType::NumberOfVertices] = {{1,2,3},{3,2,0},{0,1,3},{2,1,0}}
static const size_t	edges [NumberOfEdges][Edge::NumberOfVertices] = {{0,1},{0,2},{0,3},{1,2},{3,1},{2,3}}
Protected Attributes
size_t	__reference
	Reference of the Cell.
real_t	__volume
	Volume or surface of the cell.
Vertex **	__vertices
	Pointers on vertices of the cell.
bool	__isFictitious
	indicates if the cell is to be taken into accounts for computations

---

Detailed Description

Definition at line 37 of file Tetrahedron.hpp.

---

Member Typedef Documentation

typedef Triangle Tetrahedron::FaceType

Definition at line 47 of file Tetrahedron.hpp.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

NumberOfVertices	number of vertices
NumberOfFaces	number of faces
NumberOfEdges	number of edges

Definition at line 41 of file Tetrahedron.hpp.

       {
    NumberOfVertices   = 4,     
    NumberOfFaces      = 4,     
    NumberOfEdges      = 6      
  };

enum Cell::Type [inherited]

Enumerator:

hexahedron
cartesianHexahedron
hexahedronByEdge
tetrahedron
triangle3d
quadrangle3d

Definition at line 40 of file Cell.hpp.

            {
    hexahedron,
    cartesianHexahedron,
    hexahedronByEdge,
    tetrahedron,
    triangle3d,
    quadrangle3d
  };

---

Constructor & Destructor Documentation

Tetrahedron::Tetrahedron

(

)

[inline]

Default constructor does nothing but reserving memory.

Definition at line 108 of file Tetrahedron.hpp.

    : Cell(Tetrahedron::NumberOfVertices)
  {
    ;
  }

Tetrahedron::Tetrahedron	(	Vertex &	x0,
		Vertex &	x1,
		Vertex &	x2,
		Vertex &	x3,
		const size_t &	ref = 0
	)

Definition at line 22 of file Tetrahedron.cpp.

References Cell::__vertices, Cell::__volume, and ErrorHandler::normal.

  : Cell(Tetrahedron::NumberOfVertices, ref)
{
  __vertices[0] = &x0;
  __vertices[1] = &x1;
  __vertices[2] = &x2;
  __vertices[3] = &x3;

  TinyVector<3> A = x1 - x0;
  TinyVector<3> B = x2 - x0;
  TinyVector<3> C = x3 - x0;

  __volume = 1./6.*((A^B)*C);
  if (__volume < 0) {
    throw ErrorHandler(__FILE__,__LINE__,
                       "negative tetrahedron volume",
                       ErrorHandler::normal);
  }
}

Tetrahedron::~Tetrahedron

(

)

[inline]

Definition at line 120 of file Tetrahedron.hpp.

  {
    ;
  }

---

Member Function Documentation

virtual Cell::Type Tetrahedron::type

(

)

const [inline, virtual]

Access to the type of the cell

Returns:

the cell type

Implements Cell.

Definition at line 52 of file Tetrahedron.hpp.

References Cell::tetrahedron.

  {
    return Cell::tetrahedron;
  }

void Tetrahedron::getBarycentricCoordinates	(	const TinyVector< 3, real_t > &	X,
		TinyVector< 4, real_t > &	lambda
	)			const [inline]

computes barycentric coordinates in the current tetrahedron related to a given X position.

Parameters:

	X	Cartesian coordinates
	lambda	barycentric coordinates

Todo:

This could be optimized

Definition at line 66 of file Tetrahedron.hpp.

Referenced by MeshOfTetrahedra::find(), and Convection< MeshOfTetrahedra >::operator()().

  {
    TinyVector<4, real_t> X2;
    for (size_t i=0; i<3; ++i) X2[i] = X[i];
    X2[3] = 1;

    TinyMatrix<4, 4, real_t> M = 0;
    for (size_t i=0; i<4; ++i) {
      const Vertex& V = (*this)(i);
      for (size_t j=0; j<3; ++j) {
        M(j, i) = V[j];
      }
    }

    for (size_t i=0; i<4; ++i) {
      M(3,i) = 1;
    }

    lambda = X2/M;
  }

size_t Tetrahedron::numberOfVertices

(

)

const [inline, virtual]

Number of Vertices.

Implements Cell.

Definition at line 89 of file Tetrahedron.hpp.

References NumberOfVertices.

  {
    return NumberOfVertices;
  }

size_t Tetrahedron::numberOfEdges

(

)

const [inline]

Number of Edges.

Definition at line 95 of file Tetrahedron.hpp.

References NumberOfEdges.

  {
    return NumberOfEdges;
  }

const Tetrahedron& Tetrahedron::operator=

(

const Tetrahedron &

T

)

[inline]

sets equal to a given tetrahedron

Definition at line 101 of file Tetrahedron.hpp.

References Cell::operator=().

  {
    Cell::operator=(T);
    return *this;
  }

Here is the call graph for this function:

bool Cell::find

(

const Vertex *

P

)

[inline, inherited]

Find the vertex P in the cell

Returns:

bool

Definition at line 69 of file Cell.hpp.

References Cell::__vertices, and Cell::numberOfVertices().

Referenced by Triangulation::__checkLine().

                                     {
    for(size_t i=0 ; i<numberOfVertices() ; ++i) {
      if(__vertices[i]==P) {
        return true;
      }
    }
    return false;
  }

Here is the call graph for this function:

const real_t& Cell::volume

(

)

const [inline, inherited]

Read-only access to the volume of the cell

Returns:

the volume

Definition at line 83 of file Cell.hpp.

References Cell::__volume.

Referenced by FEMDiscretization< Structured3DMesh, TypeOfDiscretization >::assembleSecondMember(), ConformTransformationP1TriangleJacobian::ConformTransformationP1TriangleJacobian(), ConformTransformationQ1QuadrangleJacobian::ConformTransformationQ1QuadrangleJacobian(), BoundaryConditionDiscretizationSpectralNonConform::getDiagonal(), BoundaryConditionDiscretizationSpectralNonConform::setSecondMember(), BoundaryConditionDiscretizationSpectralNonConform::timesX(), and BoundaryConditionDiscretizationSpectralNonConform::transposedTimesX().

  {
    return __volume;
  }

void Cell::replace	(	Vertex *	v0,
		Vertex *	v1
	)			[inline, inherited]

Replaces a vertex by another

Parameters:

	v0	the vertex to replace
	v1	the new vertex

Definition at line 94 of file Cell.hpp.

References Cell::__vertices, Cell::numberOfVertices(), stringify(), and ErrorHandler::unexpected.

  {
    for (size_t i = 0; i<numberOfVertices(); ++i) {
      if (__vertices[i] == v0) {
        __vertices[i] = v1;
        return;
      }
    }

    const std::string errorMsg
      = "vertex "+stringify(v0)+" was not found while replacing "+stringify(v1);

    throw ErrorHandler(__FILE__,__LINE__,
                       errorMsg,
                       ErrorHandler::unexpected);
  }

Here is the call graph for this function:

const bool& Cell::isFictitious

(

)

const [inline, inherited]

Read-only access to the fictitious state of the cell

Returns:

true if the cell is fictitious

Definition at line 116 of file Cell.hpp.

References Cell::__isFictitious.

Referenced by FEMDiscretization< Structured3DMesh, TypeOfDiscretization >::assembleSecondMember().

  {
    return __isFictitious;
  }

void Cell::setFictitious

(

const bool &

b

)

const [inline, inherited]

Sets fictitious state of the cell

Note:

method is const since this does not change the cell. Fictitious state is a mutable member!

Definition at line 127 of file Cell.hpp.

References Cell::__isFictitious.

Referenced by FictitiousDomainMethod::Compute().

  {
    __isFictitious = b;
  }

const size_t& Cell::reference

(

)

const [inline, inherited]

Read-only access to the reference of the Cell.

Returns:

a const reference to the reference

Definition at line 151 of file Cell.hpp.

References Cell::__reference.

Referenced by SurfaceMeshGenerator::Internals::__constructionFinalMesh(), SurfaceMeshGenerator::Internals::__createGeneral(), SurfaceMeshGenerator::Internals::__createSurface(), SurfaceMeshGenerator::Internals::__createTriangle(), SurfaceMeshGenerator::Internals::__createTrianglesIntersection(), SurfaceMeshGenerator::Internals::__generateMesh(), SurfaceMeshGenerator::Internals::__putRefByFront(), SurfaceMeshGenerator::Internals::UnionTest::compute(), SurfaceMeshGenerator::Internals::IntersectionTest::compute(), SurfaceMeshGenerator::generateSurfacicMesh(), and MeshDomainTetrahedrizor::run().

  {
    return __reference;
  }

size_t& Cell::reference

(

)

[inline, inherited]

Access to the reference of the Cell.

Returns:

a reference to the reference

Definition at line 161 of file Cell.hpp.

References Cell::__reference.

  {
    return __reference;
  }

Vertex& Cell::operator()

(

const size_t &

i

)

[inline, inherited]

Access to the ith Vertex of the Cell.

Parameters:

i

the local number of the vertex

Returns:

a reference to a the vertex

Definition at line 173 of file Cell.hpp.

References Cell::__vertices, ASSERT, and Cell::numberOfVertices().

  {
    ASSERT (i<numberOfVertices());
    return *__vertices[i];
  }

Here is the call graph for this function:

const Vertex& Cell::operator()

(

const size_t &

i

)

const [inline, inherited]

Read-only access to the ith Vertex of the Cell.

Parameters:

i

the local number of the vertex

Returns:

a const reference to a the vertex

Definition at line 186 of file Cell.hpp.

References Cell::__vertices, ASSERT, and Cell::numberOfVertices().

  {
    ASSERT (i<numberOfVertices());
    return *(__vertices[i]);
  }

Here is the call graph for this function:

---

Member Data Documentation

const size_t Tetrahedron::faces = {{1,2,3},{3,2,0},{0,1,3},{2,1,0}} [static]

Definition at line 49 of file Tetrahedron.hpp.

const size_t Tetrahedron::edges = {{0,1},{0,2},{0,3},{1,2},{3,1},{2,3}} [static]

Definition at line 50 of file Tetrahedron.hpp.

size_t Cell::__reference [protected, inherited]

Reference of the Cell.

Definition at line 51 of file Cell.hpp.

Referenced by Cell::operator=(), and Cell::reference().

real_t Cell::__volume [protected, inherited]

Volume or surface of the cell.

Definition at line 54 of file Cell.hpp.

Referenced by Triangle::__computeVolume(), Quadrangle::__computeVolume(), CartesianHexahedron::CartesianHexahedron(), Hexahedron::Hexahedron(), Cell::operator=(), Quadrangle::Quadrangle(), Tetrahedron(), and Cell::volume().

Vertex** Cell::__vertices [protected, inherited]

Pointers on vertices of the cell.

Definition at line 57 of file Cell.hpp.

Referenced by Triangle::__computeVolume(), Quadrangle::__computeVolume(), ConnectedTriangle::base(), CartesianHexahedron::CartesianHexahedron(), Cell::Cell(), Triangle::edge(), Cell::find(), CartesianHexahedron::getLocalCoordinates(), Hexahedron::Hexahedron(), Triangle::normal(), Quadrangle::normal(), Cell::operator()(), Cell::operator=(), Quadrangle::Quadrangle(), Cell::replace(), ConnectedTriangle::setVertices(), Tetrahedron(), Triangle::Triangle(), and Cell::~Cell().

bool Cell::__isFictitious [mutable, protected, inherited]

indicates if the cell is to be taken into accounts for computations

Definition at line 60 of file Cell.hpp.

Referenced by Cell::isFictitious(), and Cell::setFictitious().

---

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

• Tetrahedron.hpp
• Tetrahedron.cpp