Flumy [Free API]
Process based model for meandering chanelized systems
Public Member Functions | List of all members
DepositUnit Class Reference

Storage class used to access DepositionUnit members (Domain sample informations). More...

Detailed Description

Storage class used to access DepositionUnit members (Domain sample informations).

DepositUnit objects are returned by the method iDomain::getIrregular.
Each deposition unit owns three parameters:

Public Member Functions

 DepositUnit ()
 Default Constructor. More...
 
 DepositUnit (MP_stut nature, MP_real thickness, MP_age age, MP_real granulo)
 Default constructor. More...
 
 DepositUnit (const DepositUnit &dep)
 Copy constructor. More...
 
virtual ~DepositUnit ()
 Destructor. More...
 
MP_stut getNature () const
 Return the facies identifier of the sample (identifiers are defined in MCRCDefines.h file) More...
 
MP_real getThickness () const
 Return the thickness of the sample (in meters) More...
 
MP_age getAge () const
 Return the age of the sample. More...
 
MP_real getGranulo () const
 Return the grain size rate of the sample ]0., 1.]. More...
 

Constructor & Destructor Documentation

◆ DepositUnit() [1/3]

DepositUnit::DepositUnit ( )
inline

Default Constructor.

◆ DepositUnit() [2/3]

DepositUnit::DepositUnit ( MP_stut  nature,
MP_real  thickness,
MP_age  age,
MP_real  granulo 
)
inline

Default constructor.

◆ DepositUnit() [3/3]

DepositUnit::DepositUnit ( const DepositUnit dep)
inline

Copy constructor.

◆ ~DepositUnit()

virtual DepositUnit::~DepositUnit ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ getAge()

MP_age DepositUnit::getAge ( ) const
inline

Return the age of the sample.

◆ getGranulo()

MP_real DepositUnit::getGranulo ( ) const
inline

Return the grain size rate of the sample ]0., 1.].

◆ getNature()

MP_stut DepositUnit::getNature ( ) const
inline

Return the facies identifier of the sample (identifiers are defined in MCRCDefines.h file)

◆ getThickness()

MP_real DepositUnit::getThickness ( ) const
inline

Return the thickness of the sample (in meters)