FracEnviron Class Reference

#include <FracEnviron.hpp>

Inheritance diagram for 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 ()
virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable. More...
int	getNFamilies () const
int	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 (int i) const
const FracFamily &	getFamily (int i) const
void	addFamily (const FracFamily &family)
void	addFault (const FracFault &fault)
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
Public Member Functions inherited from ASerializable
	ASerializable ()
	ASerializable (const ASerializable &r)
ASerializable &	operator= (const ASerializable &r)
virtual	~ASerializable ()
bool	deserialize (std::istream &is, bool verbose=true)
bool	serialize (std::ostream &os, bool verbose=true) const
bool	dumpToNF (const String &neutralFilename, bool verbose=false) const

Static Public Member Functions
static FracEnviron *	createFromNF (const String &neutralFilename, 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 ASerializable
static String	buildFileName (int status, const String &filename, bool ensureDirExist=false)
static String	getHomeDirectory (const String &sub="")
static String	getWorkingDirectory ()
static String	getTestData (const String &subdir, const String &filename)
static String	getFileIdentity (const String &filename, bool verbose=false)
static void	setContainerName (bool useDefault, const String &containerName="", bool verbose=false)
static void	unsetContainerName ()
static void	setPrefixName (const String &prefixName)
static void	unsetPrefixName ()
static const String &	getContainerName ()
static const String &	getPrefixName ()
static bool	createDirectory (const String &dir)
static String	getExecDirectory ()
static String	getDirectory (const String &path)

Constructor & Destructor Documentation

FracEnviron() [1/2]

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

FracEnviron() [2/2]

FracEnviron::FracEnviron

(

const FracEnviron &

r

)

~FracEnviron()

FracEnviron::~FracEnviron ( )

virtual

Member Function Documentation

addFamily()

void FracEnviron::addFamily ( const FracFamily &  family )

inline

addFault()

void FracEnviron::addFault ( const FracFault &  fault )

inline

create()

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

static

createFromNF()

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

static

Create a Environ by loading the contents of a Neutral File

Parameters

neutralFilename	Name of the Neutral File
verbose	Verbose

getDeltax()

double FracEnviron::getDeltax ( ) const

inline

getDeltay()

double FracEnviron::getDeltay ( ) const

inline

getFamily()

const FracFamily& FracEnviron::getFamily ( int  i ) const

inline

getFault()

const FracFault& FracEnviron::getFault ( int  i ) const

inline

getMean()

double FracEnviron::getMean ( ) const

inline

getNFamilies()

int FracEnviron::getNFamilies ( ) const

inline

getNFaults()

int FracEnviron::getNFaults ( ) const

inline

getStdev()

double FracEnviron::getStdev ( ) const

inline

getXextend()

double FracEnviron::getXextend

(

)

const

getXmax()

double FracEnviron::getXmax ( ) const

inline

getYmax()

double FracEnviron::getYmax ( ) const

inline

operator=()

FracEnviron & FracEnviron::operator=

(

const FracEnviron &

r

)

toString()

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

overridevirtual

Interface to AStringable.

Reimplemented from AStringable.

---

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

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