gstlrn::FracEnviron Class Reference

#include <FracEnviron.hpp>

Inheritance diagram for gstlrn::FracEnviron:

Public Member Functions
	FracEnviron (double xmax=0., double ymax=0., double deltax=0., double deltay=0., double mean=0., double stdev=0.)
	FracEnviron (const FracEnviron &r)
FracEnviron &	operator= (const FracEnviron &r)
virtual	~FracEnviron ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable.
String	getNFName () const override
	ASerializable Interface.
Id	getNFamilies () const
Id	getNFaults () const
double	getDeltax () const
double	getDeltay () const
double	getMean () const
double	getStdev () const
double	getXmax () const
double	getYmax () const
double	getXextend () const
const FracFault &	getFault (Id i) const
const FracFamily &	getFamily (Id i) const
void	addFamily (const FracFamily &family)
void	addFault (const FracFault &fault)
Public Member Functions inherited from gstlrn::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 (Id level) const final
void	printConcreteClassName () const
Public Member Functions inherited from gstlrn::ASerializable
	ASerializable ()
	ASerializable (const ASerializable &r)=default
ASerializable &	operator= (const ASerializable &r)=default
	ASerializable (ASerializable &&r) noexcept=default
ASerializable &	operator= (ASerializable &&r) noexcept=default
virtual	~ASerializable ()=default
bool	dumpToNF (const String &NFFilename, const EFormatNF &format=EFormatNF::fromKey("DEFAULT")) const
	Dump the contents of an object into an Output File using a given Output NF Format.
void	setDefaultFormatNF (const EFormatNF &format)

Static Public Member Functions
static FracEnviron *	createFromNF (const String &NFFilename, bool verbose=true)
static FracEnviron *	create (double xmax=0., double ymax=0., double deltax=0., double deltay=0, double mean=0., double stdev=0.)
Static Public Member Functions inherited from gstlrn::ASerializable
static String	buildFileName (Id status, const String &filename, bool ensureDirExist=false)
static String	getFileIdentity (const String &filename, bool verbose=false)
static void	setPrefixName (const String &prefixName)
static void	unsetPrefixName ()
static const String &	getPrefixName ()

Constructor & Destructor Documentation

FracEnviron() [1/2]

gstlrn::FracEnviron::FracEnviron	(	double	xmax = 0.,
		double	ymax = 0.,
		double	deltax = 0.,
		double	deltay = 0.,
		double	mean = 0.,
		double	stdev = 0.
	)

FracEnviron() [2/2]

gstlrn::FracEnviron::FracEnviron

(

const FracEnviron &

r

)

~FracEnviron()

gstlrn::FracEnviron::~FracEnviron ( )

virtual

Member Function Documentation

addFamily()

void gstlrn::FracEnviron::addFamily ( const FracFamily &  family )

inline

addFault()

void gstlrn::FracEnviron::addFault ( const FracFault &  fault )

inline

create()

FracEnviron * gstlrn::FracEnviron::create ( double  xmax = 0., double  ymax = 0., double  deltax = 0., double  deltay = 0, double  mean = 0., double  stdev = 0.  )

static

createFromNF()

FracEnviron * gstlrn::FracEnviron::createFromNF ( const String &  NFFilename, bool  verbose = true  )

static

Create a Environ by loading the contents of a Neutral File

Parameters

NFFilename	Name of the Neutral File
verbose	Verbose

getDeltax()

double gstlrn::FracEnviron::getDeltax ( ) const

inline

getDeltay()

double gstlrn::FracEnviron::getDeltay ( ) const

inline

getFamily()

const FracFamily & gstlrn::FracEnviron::getFamily ( Id  i ) const

inline

getFault()

const FracFault & gstlrn::FracEnviron::getFault ( Id  i ) const

inline

getMean()

double gstlrn::FracEnviron::getMean ( ) const

inline

getNFamilies()

Id gstlrn::FracEnviron::getNFamilies ( ) const

inline

getNFaults()

Id gstlrn::FracEnviron::getNFaults ( ) const

inline

getNFName()

String gstlrn::FracEnviron::getNFName ( ) const

inlineoverridevirtual

ASerializable Interface.

Implements gstlrn::ASerializable.

getStdev()

double gstlrn::FracEnviron::getStdev ( ) const

inline

getXextend()

double gstlrn::FracEnviron::getXextend

(

)

const

getXmax()

double gstlrn::FracEnviron::getXmax ( ) const

inline

getYmax()

double gstlrn::FracEnviron::getYmax ( ) const

inline

operator=()

FracEnviron & gstlrn::FracEnviron::operator=

(

const FracEnviron &

r

)

toString()

String gstlrn::FracEnviron::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Interface to AStringable.

Reimplemented from gstlrn::AStringable.

---

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

• include/Fractures/FracEnviron.hpp
• src/Fractures/FracEnviron.cpp