GDEllipsoid Class Reference

Class describing a 3D ellipsoid geometrical domain. More...

#include <GDEllipsoid.h>

Inherits GeometricalDomain.

Collaboration diagram for GDEllipsoid:

Public Member Functions
	GDEllipsoid (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.
	~GDEllipsoid () override
bool	belong (Coord &posElement, const int &) const override
	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
	Ellipsoid position center.
Axis	m_axis1
Axis	m_axis2
Axis	m_axis3
	Axes that define the Ellipsoid plane.
double	m_radius1
double	m_radius2
double	m_radius3
	Ellipsoid radii.

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 3D ellipsoid geometrical domain.

Constructor & Destructor Documentation

GDEllipsoid()

GDEllipsoid::GDEllipsoid	(	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: <dataEllipsoid axis1="x" axis2="y" axis3="z" radius1="1." radius2="1.5" radius3="1.5"> </dataEllipsoid>

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:

~GDEllipsoid()

GDEllipsoid::~GDEllipsoid ( )

override

Member Function Documentation

belong()

bool GDEllipsoid::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:

Member Data Documentation

m_axis1

Axis GDEllipsoid::m_axis1

private

m_axis2

Axis GDEllipsoid::m_axis2

private

m_axis3

Axis GDEllipsoid::m_axis3

private

Axes that define the Ellipsoid plane.

m_centerPos

Coord GDEllipsoid::m_centerPos

private

Ellipsoid position center.

m_radius1

double GDEllipsoid::m_radius1

private

m_radius2

double GDEllipsoid::m_radius2

private

m_radius3

double GDEllipsoid::m_radius3

private

Ellipsoid radii.

---

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

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