SimuSubstitutionParam Class Reference

#include <SimuSubstitutionParam.hpp>

Inheritance diagram for SimuSubstitutionParam:

Public Member Functions
	SimuSubstitutionParam (int nfacies=2, double intensity=0.1, bool flag_direct=true, bool flag_coding=true, bool flag_orient=false)
	SimuSubstitutionParam (const SimuSubstitutionParam &r)
SimuSubstitutionParam &	operator= (const SimuSubstitutionParam &r)
virtual	~SimuSubstitutionParam ()
virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable. More...
const VectorInt &	getColang () const
void	setColang (const VectorInt &colang)
int	getColfac () const
void	setColfac (int colfac)
double	getFactor () const
void	setFactor (double factor)
bool	isFlagAuto () const
void	setFlagAuto (bool flagAuto)
bool	isFlagCoding () const
void	setFlagCoding (bool flagCoding)
bool	isFlagDirect () const
void	setFlagDirect (bool flagDirect)
bool	isFlagOrient () const
void	setFlagOrient (bool flagOrient)
double	getIntensity () const
void	setIntensity (double intensity)
int	getNfacies () const
void	setNfacies (int nfacies)
int	getNstates () const
void	setNstates (int nstates)
const VectorDouble	getTrans () const
void	setTrans (const VectorDouble &trans)
const VectorDouble &	getVector () const
void	setVector (const VectorDouble &vector)
int	getColang (int idim) const
double	getVector (int idim) const
bool	isValid (bool verbose=false)
void	isValidOrientation (VectorDouble &vector, bool verbose=false) const
void	isValidFactor (double *factor, bool verbose=false) const
bool	isAngleLocal () const
bool	isLocal () const
Public Member Functions inherited from AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (int level) const final

Private Member Functions
bool	_isIrreductibility (bool verbose=false)
bool	_isValidTransition (bool verbose=false, double eps=EPSILON3)

Private Attributes
int	_nfacies
int	_nstates
int	_colfac
bool	_flagDirect
bool	_flagCoding
bool	_flagOrient
bool	_flagAuto
double	_intensity
double	_factor
VectorInt	_colang
VectorDouble	_vector
VectorDouble	_trans

Constructor & Destructor Documentation

SimuSubstitutionParam() [1/2]

SimuSubstitutionParam::SimuSubstitutionParam	(	int	nfacies = 2,
		double	intensity = 0.1,
		bool	flag_direct = true,
		bool	flag_coding = true,
		bool	flag_orient = false
	)

SimuSubstitutionParam() [2/2]

SimuSubstitutionParam::SimuSubstitutionParam

(

const SimuSubstitutionParam &

r

)

~SimuSubstitutionParam()

SimuSubstitutionParam::~SimuSubstitutionParam ( )

virtual

Member Function Documentation

_isIrreductibility()

bool SimuSubstitutionParam::_isIrreductibility ( bool  verbose = false )

private

Check if the transition matrix is irreductible

Returns

1 if the transition matrix is not irreductible; 0 otherwise

Parameters

[in]

verbose

Verbose option

_isValidTransition()

bool SimuSubstitutionParam::_isValidTransition ( bool  verbose = false, double  eps = EPSILON3  )

private

getColang() [1/2]

const VectorInt& SimuSubstitutionParam::getColang ( ) const

inline

getColang() [2/2]

int SimuSubstitutionParam::getColang

(

int

idim

)

const

getColfac()

int SimuSubstitutionParam::getColfac ( ) const

inline

getFactor()

double SimuSubstitutionParam::getFactor ( ) const

inline

getIntensity()

double SimuSubstitutionParam::getIntensity ( ) const

inline

getNfacies()

int SimuSubstitutionParam::getNfacies ( ) const

inline

getNstates()

int SimuSubstitutionParam::getNstates ( ) const

inline

getTrans()

const VectorDouble SimuSubstitutionParam::getTrans ( ) const

inline

getVector() [1/2]

const VectorDouble& SimuSubstitutionParam::getVector ( ) const

inline

getVector() [2/2]

double SimuSubstitutionParam::getVector ( int  idim ) const

inline

isAngleLocal()

bool SimuSubstitutionParam::isAngleLocal

(

)

const

isFlagAuto()

bool SimuSubstitutionParam::isFlagAuto ( ) const

inline

isFlagCoding()

bool SimuSubstitutionParam::isFlagCoding ( ) const

inline

isFlagDirect()

bool SimuSubstitutionParam::isFlagDirect ( ) const

inline

isFlagOrient()

bool SimuSubstitutionParam::isFlagOrient ( ) const

inline

isLocal()

bool SimuSubstitutionParam::isLocal

(

)

const

isValid()

bool SimuSubstitutionParam::isValid

(

bool

verbose = false

)

isValidFactor()

void SimuSubstitutionParam::isValidFactor	(	double *	factor,
		bool	verbose = false
	)		const

isValidOrientation()

void SimuSubstitutionParam::isValidOrientation	(	VectorDouble &	vector,
		bool	verbose = false
	)		const

operator=()

SimuSubstitutionParam & SimuSubstitutionParam::operator=

(

const SimuSubstitutionParam &

r

)

setColang()

void SimuSubstitutionParam::setColang ( const VectorInt &  colang )

inline

setColfac()

void SimuSubstitutionParam::setColfac ( int  colfac )

inline

setFactor()

void SimuSubstitutionParam::setFactor ( double  factor )

inline

setFlagAuto()

void SimuSubstitutionParam::setFlagAuto ( bool  flagAuto )

inline

setFlagCoding()

void SimuSubstitutionParam::setFlagCoding ( bool  flagCoding )

inline

setFlagDirect()

void SimuSubstitutionParam::setFlagDirect ( bool  flagDirect )

inline

setFlagOrient()

void SimuSubstitutionParam::setFlagOrient ( bool  flagOrient )

inline

setIntensity()

void SimuSubstitutionParam::setIntensity ( double  intensity )

inline

setNfacies()

void SimuSubstitutionParam::setNfacies ( int  nfacies )

inline

setNstates()

void SimuSubstitutionParam::setNstates ( int  nstates )

inline

setTrans()

void SimuSubstitutionParam::setTrans ( const VectorDouble &  trans )

inline

setVector()

void SimuSubstitutionParam::setVector ( const VectorDouble &  vector )

inline

toString()

String SimuSubstitutionParam::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Interface to AStringable.

Reimplemented from AStringable.

Member Data Documentation

_colang

VectorInt SimuSubstitutionParam::_colang

private

_colfac

int SimuSubstitutionParam::_colfac

private

_factor

double SimuSubstitutionParam::_factor

private

_flagAuto

bool SimuSubstitutionParam::_flagAuto

private

_flagCoding

bool SimuSubstitutionParam::_flagCoding

private

_flagDirect

bool SimuSubstitutionParam::_flagDirect

private

_flagOrient

bool SimuSubstitutionParam::_flagOrient

private

_intensity

double SimuSubstitutionParam::_intensity

private

_nfacies

int SimuSubstitutionParam::_nfacies

private

_nstates

int SimuSubstitutionParam::_nstates

private

_trans

VectorDouble SimuSubstitutionParam::_trans

private

_vector

VectorDouble SimuSubstitutionParam::_vector

private

---

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

• include/Simulation/SimuSubstitutionParam.hpp
• src/Simulation/SimuSubstitutionParam.cpp