GDCylinder Class Reference

Class describing a cylinder geometrical domain. More...

#include <GDCylinder.h>

Inherits GeometricalDomain.

Public Member Functions
	GDCylinder (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.
virtual	~GDCylinder ()
virtual bool	belong (Coord &posElement, const int &) const
	Method to verify inclusion of a vertex in geometrical 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 ()
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 ()

Private Attributes
Coord	m_centerPos
	Cylinder position center.
Axis	m_axis1
Axis	m_axis2
Axis	m_axis3
	Axes that define the cylinder plane and the length direction.
double	m_radius
	Cylinder radius.
double	m_length
	Cylinder length.

Additional Inherited Members
Protected Attributes inherited from GeometricalDomain
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

Class describing a cylinder geometrical domain.

Constructor & Destructor Documentation

GDCylinder()

GDCylinder::GDCylinder	(	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: <dataCylinder axis1="x" axis2="y" radius="0.5"> </dataCylinder>

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

~GDCylinder()

GDCylinder::~GDCylinder ( )

virtual

Member Function Documentation

belong()

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

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

Implements GeometricalDomain.

Member Data Documentation

m_axis1

Axis GDCylinder::m_axis1

private

m_axis2

Axis GDCylinder::m_axis2

private

m_axis3

Axis GDCylinder::m_axis3

private

Axes that define the cylinder plane and the length direction.

m_centerPos

Coord GDCylinder::m_centerPos

private

Cylinder position center.

m_length

double GDCylinder::m_length

private

Cylinder length.

m_radius

double GDCylinder::m_radius

private

Cylinder radius.

---

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

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