NeighMoving Class Reference

#include <NeighMoving.hpp>

Inheritance diagram for NeighMoving:

Public Member Functions
	NeighMoving (bool flag_xvalid=false, int nmaxi=1000, double radius=TEST, int nmini=1, int nsect=1, int nsmax=ITEST, VectorDouble coeffs=VectorDouble(), VectorDouble angles=VectorDouble(), double distcont=TEST, const Faults *faults=nullptr, const ASpace *space=nullptr)
	NeighMoving (const NeighMoving &r)
NeighMoving &	operator= (const NeighMoving &r)
virtual	~NeighMoving ()
virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface for AStringable. More...
virtual int	getMaxSampleNumber (const Db *db) const override
	Interface for ANeighParam. More...
virtual ENeigh	getType () const override
virtual bool	getFlagContinuous () const override
void	addFaults (const Faults *faults)
const VectorDouble &	getAnisoCoeffs () const
double	getAnisoCoeff (int i) const
const VectorDouble &	getAnisoRotMats () const
double	getAnisoRotMat (int i) const
int	getFlagAniso () const
int	getFlagRotation () const
bool	getFlagSector () const
int	getNMaxi () const
int	getNMini () const
int	getNSect () const
int	getNSMax () const
double	getRadius () const
double	getDistCont () const
bool	getForceWithinBlock () const
void	setAnisoCoeffs (const VectorDouble &anisoCoeffs)
void	setAnisoCoeff (int idim, double value)
void	anisoRescale ()
void	setAnisoRotMat (const VectorDouble &anisoRotMat)
void	setFlagAniso (int flagAniso)
void	setFlagRotation (int flagRotation)
void	setNMaxi (int nmaxi)
void	setNMini (int nmini)
void	setNSect (int nsect)
void	setNSMax (int nsmax)
void	setRadius (double radius)
void	setDistCont (double distCont)
void	setForceWithinBlock (bool forceWithinBlock)
VectorVectorDouble	getEllipsoid (const VectorDouble &target, int count=360) const
VectorVectorDouble	getSectors (const VectorDouble &target) const
bool	hasFaults () const
const Faults *	getFaults () const
Public Member Functions inherited from ANeighParam
	ANeighParam (bool flag_xvalid=false, const ASpace *space=nullptr)
	ANeighParam (const ANeighParam &r)
ANeighParam &	operator= (const ANeighParam &r)
virtual	~ANeighParam ()
virtual bool	isConsistent (const ASpace *space) const override
	ASpaceObject Interface. More...
bool	getFlagXvalid () const
bool	getFlagKFold () const
void	setFlagXvalid (bool flagXvalid)
void	setFlagKFold (bool flagKFold)
VectorInt	eval (Db *dbin, Db *dbout, int iech0) const
Public Member Functions inherited from ASpaceObject
	ASpaceObject (const ASpace *space=nullptr)
	ASpaceObject (const ASpace &space)
	ASpaceObject (const ASpaceObject &r)
ASpaceObject &	operator= (const ASpaceObject &r)
virtual	~ASpaceObject ()
const ASpace *	getSpace () const
	Accessor to the current object space context. More...
bool	isConsistent () const
	Indicate if I am consistent with my current space context. More...
VectorDouble	getUnitaryVector () const
	Return unitary vector for the current space context. More...
unsigned int	getNDim () const
	Shortcuts to ASpace methods. More...
const VectorDouble &	getOrigin () const
	Return the current space context origin coordinates. More...
double	getDistance (const SpacePoint &p1, const SpacePoint &p2) const
	Return the distance between two space points for the current space context. More...
VectorDouble	getIncrement (const SpacePoint &p1, const SpacePoint &p2) const
	Return the increment vector between two space points for the current space context. More...
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 NeighMoving *	create (bool flag_xvalid=false, int nmaxi=1000, double radius=TEST, int nmini=1, int nsect=1, int nsmax=ITEST, VectorDouble coeffs=VectorDouble(), VectorDouble angles=VectorDouble(), double distcont=TEST, const Faults *faults=nullptr, const ASpace *space=nullptr)
static NeighMoving *	createFromNF (const String &neutralFilename, bool verbose=true)
Static Public Member Functions inherited from ASerializable
static String	buildFileName (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=String(), 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)

Protected Member Functions
virtual bool	_deserialize (std::istream &is, bool verbose=false) override
	Interface for ASerializable. More...
virtual bool	_serialize (std::ostream &os, bool verbose=false) const override
String	_getNFName () const override
Protected Member Functions inherited from ASpaceObject
void	setNDim (int ndim)
	Modify the Space dimension of an already created item (To be used only during creation ... in particular when reading NF) More...
Protected Member Functions inherited from ASerializable
bool	_fileOpenWrite (const String &filename, std::ofstream &os, bool verbose=false) const
bool	_fileOpenRead (const String &filename, std::ifstream &is, bool verbose=false) const

Private Attributes
int	_flagAniso
int	_flagRotation
int	_nMini
int	_nMaxi
int	_nSect
int	_nSMax
bool	_forceWithinBlock
double	_radius
double	_distCont
VectorDouble	_anisoCoeffs
VectorDouble	_anisoRotMat
const Faults *	_faults

Additional Inherited Members
Static Protected Member Functions inherited from ASerializable
static bool	_commentWrite (std::ostream &os, const String &comment)
template<typename T >
static bool	_recordWrite (std::ostream &os, const String &title, const T &val)
template<typename T >
static bool	_recordWriteVec (std::ostream &os, const String &title, const VectorT< T > &vec)
template<typename T >
static bool	_recordRead (std::istream &is, const String &title, T &val)
template<typename T >
static bool	_recordReadVec (std::istream &is, const String &title, VectorT< T > &vec, int nvalues)
static bool	_onlyBlanks (char *string)
static bool	_tableRead (std::istream &is, const String &string, int ntab, double *tab)
static bool	_tableWrite (std::ostream &os, const String &string, int ntab, const VectorDouble &tab)
Protected Attributes inherited from ASpaceObject
const ASpace *	_space
	Current space context of the object. More...

Constructor & Destructor Documentation

NeighMoving() [1/2]

NeighMoving::NeighMoving	(	bool	flag_xvalid = false,
		int	nmaxi = 1000,
		double	radius = TEST,
		int	nmini = 1,
		int	nsect = 1,
		int	nsmax = ITEST,
		VectorDouble	coeffs = VectorDouble(),
		VectorDouble	angles = VectorDouble(),
		double	distcont = TEST,
		const Faults *	faults = nullptr,
		const ASpace *	space = nullptr
	)

NeighMoving() [2/2]

NeighMoving::NeighMoving

(

const NeighMoving &

r

)

~NeighMoving()

NeighMoving::~NeighMoving ( )

virtual

Member Function Documentation

_deserialize()

bool NeighMoving::_deserialize ( std::istream &  is, bool  verbose = false  )

overrideprotectedvirtual

Interface for ASerializable.

Reimplemented from ANeighParam.

_getNFName()

String NeighMoving::_getNFName ( ) const

inlineoverrideprotectedvirtual

Reimplemented from ANeighParam.

_serialize()

bool NeighMoving::_serialize ( std::ostream &  os, bool  verbose = false  ) const

overrideprotectedvirtual

Reimplemented from ANeighParam.

addFaults()

void NeighMoving::addFaults ( const Faults *  faults )

inline

anisoRescale()

void NeighMoving::anisoRescale

(

)

create()

NeighMoving * NeighMoving::create ( bool  flag_xvalid = false, int  nmaxi = 1000, double  radius = TEST, int  nmini = 1, int  nsect = 1, int  nsmax = ITEST, VectorDouble  coeffs = VectorDouble(), VectorDouble  angles = VectorDouble(), double  distcont = TEST, const Faults *  faults = nullptr, const ASpace *  space = nullptr  )

static

createFromNF()

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

static

Create a NeighMovingborhood by loading the contents of a Neutral File

Parameters

neutralFilename	Name of the Neutral File
verbose	Verbose flag

Returns

getAnisoCoeff()

double NeighMoving::getAnisoCoeff ( int  i ) const

inline

getAnisoCoeffs()

const VectorDouble& NeighMoving::getAnisoCoeffs ( ) const

inline

getAnisoRotMat()

double NeighMoving::getAnisoRotMat ( int  i ) const

inline

getAnisoRotMats()

const VectorDouble& NeighMoving::getAnisoRotMats ( ) const

inline

getDistCont()

double NeighMoving::getDistCont ( ) const

inline

getEllipsoid()

VectorVectorDouble NeighMoving::getEllipsoid	(	const VectorDouble &	target,
		int	count = 360
	)		const

getFaults()

const Faults* NeighMoving::getFaults ( ) const

inline

getFlagAniso()

int NeighMoving::getFlagAniso ( ) const

inline

getFlagContinuous()

virtual bool NeighMoving::getFlagContinuous ( ) const

inlineoverridevirtual

Reimplemented from ANeighParam.

getFlagRotation()

int NeighMoving::getFlagRotation ( ) const

inline

getFlagSector()

bool NeighMoving::getFlagSector

(

)

const

getForceWithinBlock()

bool NeighMoving::getForceWithinBlock ( ) const

inline

getMaxSampleNumber()

int NeighMoving::getMaxSampleNumber ( const Db *  db ) const

overridevirtual

Interface for ANeighParam.

Given a Db, returns the maximum number of samples per NeighMovingborhood

Parameters

db	Pointer to the target Db

Returns

Implements ANeighParam.

getNMaxi()

int NeighMoving::getNMaxi ( ) const

inline

getNMini()

int NeighMoving::getNMini ( ) const

inline

getNSect()

int NeighMoving::getNSect ( ) const

inline

getNSMax()

int NeighMoving::getNSMax ( ) const

inline

getRadius()

double NeighMoving::getRadius ( ) const

inline

getSectors()

VectorVectorDouble NeighMoving::getSectors

(

const VectorDouble &

target

)

const

Generate the end-points of the sectors. By default, the extension is set to radius

Parameters

target

Coordinates of the Target

Returns

getType()

virtual ENeigh NeighMoving::getType ( ) const

inlineoverridevirtual

Implements ANeighParam.

hasFaults()

bool NeighMoving::hasFaults ( ) const

inline

operator=()

NeighMoving & NeighMoving::operator=

(

const NeighMoving &

r

)

setAnisoCoeff()

void NeighMoving::setAnisoCoeff	(	int	idim,
		double	value
	)

setAnisoCoeffs()

void NeighMoving::setAnisoCoeffs ( const VectorDouble &  anisoCoeffs )

inline

setAnisoRotMat()

void NeighMoving::setAnisoRotMat ( const VectorDouble &  anisoRotMat )

inline

setDistCont()

void NeighMoving::setDistCont ( double  distCont )

inline

setFlagAniso()

void NeighMoving::setFlagAniso ( int  flagAniso )

inline

setFlagRotation()

void NeighMoving::setFlagRotation ( int  flagRotation )

inline

setForceWithinBlock()

void NeighMoving::setForceWithinBlock

(

bool

forceWithinBlock

)

setNMaxi()

void NeighMoving::setNMaxi ( int  nmaxi )

inline

setNMini()

void NeighMoving::setNMini ( int  nmini )

inline

setNSect()

void NeighMoving::setNSect ( int  nsect )

inline

setNSMax()

void NeighMoving::setNSMax ( int  nsmax )

inline

setRadius()

void NeighMoving::setRadius ( double  radius )

inline

toString()

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

overridevirtual

Interface for AStringable.

Reimplemented from ANeighParam.

Member Data Documentation

_anisoCoeffs

VectorDouble NeighMoving::_anisoCoeffs

private

_anisoRotMat

VectorDouble NeighMoving::_anisoRotMat

private

_distCont

double NeighMoving::_distCont

private

_faults

const Faults* NeighMoving::_faults

private

_flagAniso

int NeighMoving::_flagAniso

private

_flagRotation

int NeighMoving::_flagRotation

private

_forceWithinBlock

bool NeighMoving::_forceWithinBlock

private

_nMaxi

int NeighMoving::_nMaxi

private

_nMini

int NeighMoving::_nMini

private

_nSect

int NeighMoving::_nSect

private

_nSMax

int NeighMoving::_nSMax

private

_radius

double NeighMoving::_radius

private

---

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

• include/Neigh/NeighMoving.hpp
• src/Neigh/NeighMoving.cpp