Cell Class Reference

#include <Cell.hpp>

Inheritance diagram for Cell:

[legend]

Collaboration diagram for Cell:

[legend]

List of all members.

Public Types
enum	Type {   hexahedron, cartesianHexahedron, hexahedronByEdge, tetrahedron,   triangle3d, quadrangle3d }
Public Member Functions
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
virtual size_t	numberOfVertices () const =0
virtual Cell::Type	type () const =0
const size_t &	reference () const
size_t &	reference ()
Vertex &	operator() (const size_t &i)
const Vertex &	operator() (const size_t &i) const
const Cell &	operator= (const Cell &C)
	Cell (const size_t &numberOfVertices)
	Cell (const size_t &numberOfVertices, const size_t &reference)
	Cell (const Cell &C)
virtual	~Cell ()
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 38 of file Cell.hpp.

---

Member Enumeration Documentation

enum Cell::Type

Enumerator:

hexahedron
cartesianHexahedron
hexahedronByEdge
tetrahedron
triangle3d
quadrangle3d

Definition at line 40 of file Cell.hpp.

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

---

Constructor & Destructor Documentation

Cell::Cell

(

const size_t &

numberOfVertices

)

[inline]

Constructs a cell with a given number of vertices

Parameters:

numberOfVertices

the number of vertices

Definition at line 215 of file Cell.hpp.

References __vertices, and ASSERT.

    : __reference(0),
      __volume(0),
      __isFictitious(false)
  {
    ASSERT(numberOfVertices > 0);
    __vertices = new Vertex*[numberOfVertices];
  }

Cell::Cell	(	const size_t &	numberOfVertices,
		const size_t &	reference
	)			[inline]

Constructs a cell with a given number of vertices and a given reference

Parameters:

	numberOfVertices	the number of vertices
	reference	the given reference

Definition at line 231 of file Cell.hpp.

References __vertices, and ASSERT.

    : __reference(reference),
      __volume(0),
      __isFictitious(false)
  {
    ASSERT(numberOfVertices > 0);
    __vertices = new Vertex*[numberOfVertices];
  }

Cell::Cell

(

const Cell &

C

)

[inline]

Copies a given cell

Parameters:

C

the given cell

Definition at line 245 of file Cell.hpp.

References __vertices, and numberOfVertices().

    : __reference(C.__reference),
      __volume(C.__volume),
      __isFictitious(C.__isFictitious)
  {
    __vertices = new Vertex*[C.numberOfVertices()];
    for (size_t i=0; i<C.numberOfVertices(); ++i)
      __vertices[i] = C.__vertices[i];
  }

Here is the call graph for this function:

virtual Cell::~Cell

(

)

[inline, virtual]

The destructor

Definition at line 259 of file Cell.hpp.

References __vertices.

  {
    delete [] __vertices;
  }

---

Member Function Documentation

bool Cell::find

(

const Vertex *

P

)

[inline]

Find the vertex P in the cell

Returns:

bool

Definition at line 69 of file Cell.hpp.

References __vertices, and 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]

Read-only access to the volume of the cell

Returns:

the volume

Definition at line 83 of file Cell.hpp.

References __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]

Replaces a vertex by another

Parameters:

	v0	the vertex to replace
	v1	the new vertex

Definition at line 94 of file Cell.hpp.

References __vertices, 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]

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

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

  {
    return __isFictitious;
  }

void Cell::setFictitious

(

const bool &

b

)

const [inline]

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

Referenced by FictitiousDomainMethod::Compute().

  {
    __isFictitious = b;
  }

virtual size_t Cell::numberOfVertices

(

)

const [pure virtual]

Read-only ccess to the number of vertices

Returns:

the number of vertices

Implemented in CartesianHexahedron, Hexahedron, Quadrangle, Tetrahedron, and Triangle.

Referenced by SurfaceMeshGenerator::Internals::__createTrianglesIntersection(), Cell(), SurfaceMeshGenerator::Internals::UnionTest::compute(), SurfaceMeshGenerator::Internals::IntersectionTest::compute(), find(), operator()(), operator=(), and replace().

virtual Cell::Type Cell::type

(

)

const [pure virtual]

Access to the type of the cell

Returns:

the cell type

Implemented in CartesianHexahedron, Hexahedron, Quadrangle, Tetrahedron, and Triangle.

const size_t& Cell::reference

(

)

const [inline]

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 __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]

Access to the reference of the Cell.

Returns:

a reference to the reference

Definition at line 161 of file Cell.hpp.

References __reference.

  {
    return __reference;
  }

Vertex& Cell::operator()

(

const size_t &

i

)

[inline]

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 __vertices, ASSERT, and 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]

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 __vertices, ASSERT, and numberOfVertices().

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

Here is the call graph for this function:

const Cell& Cell::operator=

(

const Cell &

C

)

[inline]

Sets the cell to a given one

Parameters:

C

the given cell

Returns:

the modified cell

Definition at line 199 of file Cell.hpp.

References __reference, __vertices, __volume, and numberOfVertices().

Referenced by Tetrahedron::operator=(), SurfElem::operator=(), Hexahedron::operator=(), and CartesianHexahedron::operator=().

  {
    __reference = C.__reference;
    __volume = C.__volume;

    for (size_t i=0; i<C.numberOfVertices(); ++i)
      __vertices[i] = C.__vertices[i];

    return *this;
  }

Here is the call graph for this function:

---

Member Data Documentation

size_t Cell::__reference [protected]

Reference of the Cell.

Definition at line 51 of file Cell.hpp.

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

real_t Cell::__volume [protected]

Volume or surface of the cell.

Definition at line 54 of file Cell.hpp.

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

Vertex** Cell::__vertices [protected]

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(), Triangle::edge(), find(), CartesianHexahedron::getLocalCoordinates(), Hexahedron::Hexahedron(), Triangle::normal(), Quadrangle::normal(), operator()(), operator=(), Quadrangle::Quadrangle(), replace(), ConnectedTriangle::setVertices(), Tetrahedron::Tetrahedron(), Triangle::Triangle(), and ~Cell().

bool Cell::__isFictitious [mutable, protected]

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

Definition at line 60 of file Cell.hpp.

Referenced by isFictitious(), and setFictitious().

---

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

• Cell.hpp