gstlearn  0.3.3
CCC
ADriftElem Class Referenceabstract

#include <ADriftElem.hpp>

Inheritance diagram for ADriftElem:
ADrift ASerializable ICloneable ASpaceObject AStringable Drift1 DriftF DriftX DriftX2 DriftX2Y DriftX3 DriftXY DriftXY2 DriftXZ DriftY DriftY2 DriftY3 DriftYZ DriftZ DriftZ2 DriftZ3

Public Member Functions

 ADriftElem (const EDrift &type, const CovContext &ctxt=CovContext(), int rankFex=0)
 
 ADriftElem (const ADriftElem &r)
 
ADriftElemoperator= (const ADriftElem &r)
 
virtual ~ADriftElem ()
 
virtual String toString (const AStringFormat *strfmt=nullptr) const override
 AStringable Interface. More...
 
virtual bool isConsistent (const ASpace *space) const override
 ASpaceObject Interface. More...
 
virtual int getNVariables () const override
 ADrift Interface. More...
 
virtual String getDriftSymbol () const =0
 
virtual String getDriftName () const =0
 
virtual int getOrderIRF () const =0
 
virtual int getNDim () const
 
virtual bool getDriftExternal () const
 
virtual double eval (const Db *db, int iech) const override=0
 TODO : Change ADrift::eval args from {Db,iech} to {SpacePoint p1, SpacePoint p2}. More...
 
int getRankFex () const
 
void setRankFex (int rankFex)
 
const EDrift & getType () const
 
void setType (const EDrift &type)
 
void copyCovContext (const CovContext &ctxt)
 
- Public Member Functions inherited from ADrift
 ADrift (const ASpace *space=nullptr)
 
 ADrift (const ADrift &r)
 
ADriftoperator= (const ADrift &r)
 
virtual ~ADrift ()
 
- Public Member Functions inherited from ASpaceObject
 ASpaceObject (const ASpace *space=nullptr)
 
 ASpaceObject (const ASpace &space)
 
 ASpaceObject (const ASpaceObject &r)
 
ASpaceObjectoperator= (const ASpaceObject &r)
 
virtual ~ASpaceObject ()
 
const ASpacegetSpace () 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 VectorDoublegetOrigin () 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)
 
AStringableoperator= (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)
 
ASerializableoperator= (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
 
- Public Member Functions inherited from ICloneable
 ICloneable ()
 
virtual ~ICloneable ()
 
virtual ICloneableclone () const =0
 

Protected Member Functions

virtual bool _deserialize (std::istream &is, bool verbose=false) override
 Interface to 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

CovContext _ctxt
 
EDrift _type
 
int _rankFex
 

Additional Inherited Members

- 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=String(), bool verbose=false)
 
static void unsetContainerName ()
 
static void setPrefixName (const String &prefixName)
 
static void unsetPrefixName ()
 
static const StringgetContainerName ()
 
static const StringgetPrefixName ()
 
static bool createDirectory (const String &dir)
 
static String getExecDirectory ()
 
static String getDirectory (const String &path)
 
- 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

◆ ADriftElem() [1/2]

ADriftElem::ADriftElem ( const EDrift &  type,
const CovContext ctxt = CovContext(),
int  rankFex = 0 
)

◆ ADriftElem() [2/2]

ADriftElem::ADriftElem ( const ADriftElem r)

◆ ~ADriftElem()

ADriftElem::~ADriftElem ( )
virtual

Member Function Documentation

◆ _deserialize()

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

Interface to ASerializable.

Implements ASerializable.

◆ _getNFName()

String ADriftElem::_getNFName ( ) const
inlineoverrideprotectedvirtual

Implements ASerializable.

◆ _serialize()

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

Implements ASerializable.

◆ copyCovContext()

void ADriftElem::copyCovContext ( const CovContext ctxt)
inline

◆ eval()

virtual double ADriftElem::eval ( const Db db,
int  iech 
) const
overridepure virtual

TODO : Change ADrift::eval args from {Db,iech} to {SpacePoint p1, SpacePoint p2}.

Implements ADrift.

Implemented in DriftZ3, DriftZ2, DriftZ, DriftYZ, DriftY3, DriftY2, DriftY, DriftXZ, DriftXY2, DriftXY, DriftX3, DriftX2Y, DriftX2, DriftX, DriftF, and Drift1.

◆ getDriftExternal()

virtual bool ADriftElem::getDriftExternal ( ) const
inlinevirtual

Reimplemented in DriftF.

◆ getDriftName()

virtual String ADriftElem::getDriftName ( ) const
pure virtual

◆ getDriftSymbol()

virtual String ADriftElem::getDriftSymbol ( ) const
pure virtual

◆ getNDim()

virtual int ADriftElem::getNDim ( ) const
inlinevirtual

◆ getNVariables()

virtual int ADriftElem::getNVariables ( ) const
inlineoverridevirtual

ADrift Interface.

Implements ADrift.

◆ getOrderIRF()

virtual int ADriftElem::getOrderIRF ( ) const
pure virtual

◆ getRankFex()

int ADriftElem::getRankFex ( ) const
inline

◆ getType()

const EDrift& ADriftElem::getType ( ) const
inline

◆ isConsistent()

bool ADriftElem::isConsistent ( const ASpace space) const
overridevirtual

ASpaceObject Interface.

Implements ASpaceObject.

◆ operator=()

ADriftElem & ADriftElem::operator= ( const ADriftElem r)

◆ setRankFex()

void ADriftElem::setRankFex ( int  rankFex)
inline

◆ setType()

void ADriftElem::setType ( const EDrift &  type)
inline

◆ toString()

String ADriftElem::toString ( const AStringFormat strfmt = nullptr) const
overridevirtual

AStringable Interface.

Reimplemented from ASpaceObject.

Member Data Documentation

◆ _ctxt

CovContext ADriftElem::_ctxt
private

◆ _rankFex

int ADriftElem::_rankFex
private

◆ _type

EDrift ADriftElem::_type
private

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