GDHalfSpace Class Reference

Class describing a half space geometrical domain. More...

#include <GDHalfSpace.h>

Inherits GeometricalDomain.

Collaboration diagram for GDHalfSpace:

Public Member Functions
	GDHalfSpace (std::string name, std::vector< Phase * > vecPhases, Mixture *mixture, std::vector< Transport > vecTransports, tinyxml2::XMLElement *element, const int &physicalEntity, std::string fileName="Unknown file")
	Geometrical constructor from a XML format reading.
	~GDHalfSpace () override
bool	belong (Coord &posElement, const int &) const override
	Method to verify inclusion of a vertex in geometrical domain.
void	fillIn (Cell *cell) const override
	Method to fill in the cell data with the ones of the corresponding domain.
Public Member Functions inherited from GeometricalDomain
	GeometricalDomain (std::string name, std::vector< Phase * > vecPhases, Mixture *mixture, std::vector< Transport > vecTransports, const int &physicalEntity)
	Generic geometrical constructor.
virtual	~GeometricalDomain ()
const std::string &	getName ()
const int &	getPhysicalEntity ()

Private Attributes
double	m_position
	Origin of the half space along axis.
Axis	m_axis
	Axis orthogonal to the origin plane of the half space.
int	m_direction
	Direction along axis (positive or negative).

Additional Inherited Members
Protected Attributes inherited from GeometricalDomain
std::string	m_name
	Geometrical domain name.
std::vector< Phase * >	m_vecPhases
	Phases variable vector.
Mixture *	m_mixture
	Mixture variables.
std::vector< Transport >	m_vecTransports
	Transport variables vector.
int	m_physicalEntity
	Physical entity number (see mesh software and mesh file).

Detailed Description

Class describing a half space geometrical domain.

Constructor & Destructor Documentation

GDHalfSpace()

GDHalfSpace::GDHalfSpace	(	std::string	name,
		std::vector< Phase * >	vecPhases,
		Mixture *	mixture,
		std::vector< Transport >	vecTransports,
		tinyxml2::XMLElement *	element,
		const int &	physicalEntity,
		std::string	fileName = "Unknown file" )

Geometrical constructor from a XML format reading.

Reading data from XML file under the following format: ex : <dataHalfSpace axis="x" origin="0.5" direction="positive">

Parameters

vecPhases	Phases vector variables to copy in geometrical domain
mixture	Mixture variables to copy in geometrical domain
vecTransports	Transports vector varaiables to copy in geometrical domain
element	XML element to read for geometrical properties
physicalEntity	physical entity number relative to mesh generation (see mesh tool)
fileName	String name of readed XML file

Here is the call graph for this function:

~GDHalfSpace()

GDHalfSpace::~GDHalfSpace ( )

override

Member Function Documentation

belong()

bool GDHalfSpace::belong ( Coord & , const int &  ) const

overridevirtual

Method to verify inclusion of a vertex in geometrical domain.

Parameters

posElement	Point coordinates
lvl	Level of the cell

Returns

True if the vertex belongs to geometrical domain

Implements GeometricalDomain.

Here is the call graph for this function:

Here is the caller graph for this function:

fillIn()

void GDHalfSpace::fillIn ( Cell * cell ) const

overridevirtual

Method to fill in the cell data with the ones of the corresponding domain.

Parameters

cell

Cell

Reimplemented from GeometricalDomain.

Here is the call graph for this function:

Member Data Documentation

m_axis

Axis GDHalfSpace::m_axis

private

Axis orthogonal to the origin plane of the half space.

m_direction

int GDHalfSpace::m_direction

private

Direction along axis (positive or negative).

m_position

double GDHalfSpace::m_position

private

Origin of the half space along axis.

---

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

• /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Geometries/GDHalfSpace.h
• /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Geometries/GDHalfSpace.cpp