ASpace Class Reference

#include <ASpace.hpp>

Inheritance diagram for ASpace:

Public Member Functions
	ASpace (unsigned int ndim, bool addTime=false)
	ASpace (const ASpace &r)
ASpace &	operator= (const ASpace &r)
virtual	~ASpace ()
virtual ESpaceType	getType () const =0
	Return the concrete space type. More...
void	addSpaceComponent (const ASpace *comp)
	Add a space component to me (for exemple RN(1) for time dimension) Note: The given argument is cloned. More...
unsigned int	getNComponents () const
	Get the number of space components. More...
virtual String	toString (const AStringFormat *strfmt=nullptr) const final
	Interface for AStringable. More...
void	setOrigin (const VectorDouble &origin)
	Update the origin of the space (must take into account composits) More...
unsigned int	getNDim (int ispace=-1) const
	Get the number of dimensions (if ispace is negative, return the global number of ) More...
const VectorDouble &	getOrigin (int ispace=-1) const
	Return the space origin coordinates. More...
unsigned int	getDimOffset () const
	Return the dimension offset index. More...
bool	isEqual (const ASpace *space) const
	Return true if the given space is equal to me (same dimension and space definition) More...
void	move (SpacePoint &p1, const VectorDouble &vec) const
	Move the given space point by the given vector. More...
double	getDistance (const SpacePoint &p1, const SpacePoint &p2, int ispace=0) const
	Return the distance between two space points. More...
double	getDistance (const SpacePoint &p1, const SpacePoint &p2, const Tensor &tensor, int ispace=0) const
	Return the distance between two space points with the given tensor. More...
VectorDouble	getDistances (const SpacePoint &p1, const SpacePoint &p2) const
	Return all the distances (one by space component) between two space points. More...
double	getDistance1D (const SpacePoint &p1, const SpacePoint &p2, unsigned int idim=0) const
	Return the distance along one direction between two space points. More...
double	getFrequentialDistance (const SpacePoint &p1, const SpacePoint &p2, const Tensor &tensor, int ispace=0) const
	Return the distance in frequential domain between two space points with the given tensor. More...
VectorDouble	getIncrement (const SpacePoint &p1, const SpacePoint &p2, int ispace=0) const
	Return the increment vector between two space points. 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 ICloneable
	ICloneable ()
virtual	~ICloneable ()
virtual ICloneable *	clone () const =0

Constructor & Destructor Documentation

ASpace() [1/2]

ASpace::ASpace	(	unsigned int	ndim,
		bool	addTime = false
	)

ASpace() [2/2]

ASpace::ASpace

(

const ASpace &

r

)

~ASpace()

ASpace::~ASpace ( )

virtual

Member Function Documentation

addSpaceComponent()

void ASpace::addSpaceComponent

(

const ASpace *

comp

)

Add a space component to me (for exemple RN(1) for time dimension) Note: The given argument is cloned.

getDimOffset()

unsigned int ASpace::getDimOffset ( ) const

inline

Return the dimension offset index.

getDistance() [1/2]

double ASpace::getDistance	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		const Tensor &	tensor,
		int	ispace = 0
	)		const

Return the distance between two space points with the given tensor.

getDistance() [2/2]

double ASpace::getDistance	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		int	ispace = 0
	)		const

Return the distance between two space points.

getDistance1D()

double ASpace::getDistance1D	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		unsigned int	idim = 0
	)		const

Return the distance along one direction between two space points.

getDistances()

VectorDouble ASpace::getDistances	(	const SpacePoint &	p1,
		const SpacePoint &	p2
	)		const

Return all the distances (one by space component) between two space points.

getFrequentialDistance()

double ASpace::getFrequentialDistance	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		const Tensor &	tensor,
		int	ispace = 0
	)		const

Return the distance in frequential domain between two space points with the given tensor.

getIncrement()

VectorDouble ASpace::getIncrement	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		int	ispace = 0
	)		const

Return the increment vector between two space points.

getNComponents()

unsigned int ASpace::getNComponents

(

)

const

Get the number of space components.

getNDim()

unsigned int ASpace::getNDim

(

int

ispace = -1

)

const

Get the number of dimensions (if ispace is negative, return the global number of )

getOrigin()

const VectorDouble & ASpace::getOrigin

(

int

ispace = -1

)

const

Return the space origin coordinates.

getType()

virtual ESpaceType ASpace::getType ( ) const

pure virtual

Return the concrete space type.

Implemented in SpaceSN, and SpaceRN.

isEqual()

bool ASpace::isEqual

(

const ASpace *

space

)

const

Return true if the given space is equal to me (same dimension and space definition)

move()

void ASpace::move	(	SpacePoint &	p1,
		const VectorDouble &	vec
	)		const

Move the given space point by the given vector.

operator=()

ASpace & ASpace::operator=

(

const ASpace &

r

)

setOrigin()

void ASpace::setOrigin

(

const VectorDouble &

origin

)

Update the origin of the space (must take into account composits)

TODO : not true whatever the space

toString()

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

finalvirtual

Interface for AStringable.

Reimplemented from AStringable.

---

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

• include/Space/ASpace.hpp
• src/Space/ASpace.cpp