GeometricalDomain Class Reference

General class for geometrical domain. More...

#include <GeometricalDomain.h>

Inherited by GDCuboid, GDCylinder, GDDisc, GDEllipse, GDEllipsoid, GDEntireDomain, GDEntireDomainWithParticularities, GDHalfSpace, GDRectangle, and GDSphere.

Public Member Functions
	GeometricalDomain (std::string name, std::vector< Phase * > vecPhases, Mixture *mixture, std::vector< Transport > vecTransports, const int &physicalEntity)
	Generic geometrical constructor.
virtual	~GeometricalDomain ()
virtual bool	belong (Coord &, const int &) const =0
	Method to verify inclusion of a vertex in geometrical domain.
virtual void	fillIn (Cell *cell) const
	Method to fill in the cell data with the ones of the corresponding domain.
const std::string &	getName ()
const int &	getPhysicalEntity ()

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

Detailed Description

General class for geometrical domain.

This is a pure virtual class: can not be instantiated

Constructor & Destructor Documentation

GeometricalDomain()

GeometricalDomain::GeometricalDomain	(	std::string	name,
		std::vector< Phase * >	vecPhases,
		Mixture *	mixture,
		std::vector< Transport >	vecTransports,
		const int &	physicalEntity
	)

Generic geometrical constructor.

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
physicalEntity	physical entity number relative to mesh generation (see mesh tool)

~GeometricalDomain()

GeometricalDomain::~GeometricalDomain ( )

virtual

Member Function Documentation

belong()

virtual bool GeometricalDomain::belong ( Coord &  , const int &    ) const

pure virtual

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

Implemented in GDEntireDomain, GDEntireDomainWithParticularities, GDCuboid, GDCylinder, GDDisc, GDEllipse, GDEllipsoid, GDHalfSpace, GDRectangle, and GDSphere.

fillIn()

void GeometricalDomain::fillIn ( Cell *  cell ) const

virtual

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

Parameters

cell

Cell

Reimplemented in GDEntireDomainWithParticularities, and GDHalfSpace.

getName()

const std::string & GeometricalDomain::getName ( )

inline

getPhysicalEntity()

const int & GeometricalDomain::getPhysicalEntity ( )

inline

Member Data Documentation

m_mixture

Mixture* GeometricalDomain::m_mixture

protected

Mixture variables.

m_name

std::string GeometricalDomain::m_name

protected

Geometrical domain name.

m_physicalEntity

int GeometricalDomain::m_physicalEntity

protected

Physical entity number (see mesh software and mesh file)

m_vecPhases

Phase** GeometricalDomain::m_vecPhases

protected

Phases variable vector.

m_vecTransports

Transport* GeometricalDomain::m_vecTransports

protected

Transport variables vector.

---

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

• /Users/fabien/depotsSephiroth/gitLab/ECOGEN/ecogen/src/Geometries/GeometricalDomain.h
• /Users/fabien/depotsSephiroth/gitLab/ECOGEN/ecogen/src/Geometries/GeometricalDomain.cpp