SurfElem Class Reference

#include <SurfElem.hpp>

Inheritance diagram for SurfElem:

[legend]

Collaboration diagram for SurfElem:

[legend]

List of all members.

Public Types
enum	Type {   hexahedron, cartesianHexahedron, hexahedronByEdge, tetrahedron,   triangle3d, quadrangle3d }
Public Member Functions
const Cell &	mother () const
size_t	motherCellFaceNumber () const
void	setMother (const Cell *cell, const size_t faceNumber)
const SurfElem &	operator= (const SurfElem &S)
virtual const TinyVector < 3, real_t >	normal () const =0
	SurfElem (const size_t &numberOfVertices, const size_t &reference=0)
	SurfElem (const SurfElem &s)
virtual	~SurfElem ()
	Virtual destructor.
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
Protected Attributes
const Cell *	__motherCell
size_t	__motherCellFaceNumber
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 39 of file SurfElem.hpp.

---

Member Enumeration Documentation

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

SurfElem::SurfElem	(	const size_t &	numberOfVertices,
		const size_t &	reference = 0
	)			[inline]

Definition at line 106 of file SurfElem.hpp.

    : Cell(numberOfVertices, reference),
      __motherCell(0),
      __motherCellFaceNumber(std::numeric_limits<size_t>::max())
  {
    ;
  }

SurfElem::SurfElem

(

const SurfElem &

s

)

[inline]

Definition at line 115 of file SurfElem.hpp.

    : Cell(s),
      __motherCell(s.__motherCell),
      __motherCellFaceNumber(s.__motherCellFaceNumber)
  {
    ;
  }

virtual SurfElem::~SurfElem

(

)

[inline, virtual]

Virtual destructor.

Definition at line 124 of file SurfElem.hpp.

  {
    ;
  }

---

Member Function Documentation

const Cell& SurfElem::mother

(

)

const [inline]

Access to the mother cell

Definition at line 55 of file SurfElem.hpp.

References __motherCell, and ASSERT.

Referenced by SurfaceMeshGenerator::Internals::__constructionFinalMesh(), SurfaceMeshGenerator::Internals::__createTrianglesIntersection(), MeshSimplifier::__proceed(), and SurfaceMeshGenerator::Internals::__setMotherCells().

  {
    ASSERT(__motherCell!=0);
    return *__motherCell;
  }

size_t SurfElem::motherCellFaceNumber

(

)

const [inline]

Access to the mother cell face number

Definition at line 65 of file SurfElem.hpp.

References __motherCell, __motherCellFaceNumber, and ASSERT.

  {
    ASSERT(__motherCell!=0);
    return __motherCellFaceNumber;
  }

void SurfElem::setMother	(	const Cell *	cell,
		const size_t	faceNumber
	)			[inline]

Sets the mother cell

Definition at line 75 of file SurfElem.hpp.

References __motherCell, and __motherCellFaceNumber.

Referenced by SurfaceMeshGenerator::Internals::__addTriangle(), SurfaceMeshGenerator::Internals::__constructionFinalMesh(), SurfaceMeshGenerator::Internals::__dataStructureConvertion(), MeshSimplifier::__proceed(), SurfaceMeshGenerator::Internals::__setMotherCells(), SpectralMesh::SpectralMesh(), and Structured3DMesh::Structured3DMesh().

  {
    __motherCell = cell;
    __motherCellFaceNumber = faceNumber;
  }

const SurfElem& SurfElem::operator=

(

const SurfElem &

S

)

[inline]

Operator equal

Parameters:

S

Returns:

*this

Definition at line 89 of file SurfElem.hpp.

References __motherCell, __motherCellFaceNumber, and Cell::operator=().

  {
    Cell::operator=(S);
    __motherCell = S.__motherCell;
    __motherCellFaceNumber = S.__motherCellFaceNumber;

    return *this;
  }

Here is the call graph for this function:

virtual const TinyVector<3,real_t> SurfElem::normal

(

)

const [pure virtual]

Returns the normal to the face.

Returns:

normal

Implemented in Quadrangle, and Triangle.

Referenced by NormalManager::__buildNormal().

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;
  }

virtual size_t Cell::numberOfVertices

(

)

const [pure virtual, inherited]

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::Cell(), SurfaceMeshGenerator::Internals::UnionTest::compute(), SurfaceMeshGenerator::Internals::IntersectionTest::compute(), Cell::find(), Cell::operator()(), Cell::operator=(), and Cell::replace().

virtual Cell::Type Cell::type

(

)

const [pure virtual, inherited]

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, 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 Cell* SurfElem::__motherCell [protected]

The mother cell (ie: a 3d element which interacts with the triangle)

Definition at line 47 of file SurfElem.hpp.

Referenced by mother(), motherCellFaceNumber(), operator=(), and setMother().

size_t SurfElem::__motherCellFaceNumber [protected]

Definition at line 48 of file SurfElem.hpp.

Referenced by motherCellFaceNumber(), operator=(), and setMother().

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::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::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 file:

• SurfElem.hpp