ShapeHalfSinusoid Class Reference

#include <ShapeHalfSinusoid.hpp>

Inheritance diagram for ShapeHalfSinusoid:

Public Member Functions
	ShapeHalfSinusoid (double proportion=1., double period=10., double amplitude=1., double thickness=1., double xext=1., double zext=1., double theta=0.)
	ShapeHalfSinusoid (const ShapeHalfSinusoid &r)
ShapeHalfSinusoid &	operator= (const ShapeHalfSinusoid &r)
virtual	~ShapeHalfSinusoid ()
EShape	getType () const override
	Interface for ICloneable. More...
int	getNParams () const override
bool	getFlagCutZ () const override
BooleanObject *	generateObject (int ndim=3) override
bool	belongObject (const VectorDouble &coor, const BooleanObject *object) const override
Public Member Functions inherited from AShape
	AShape ()
	AShape (const AShape &r)
AShape &	operator= (const AShape &r)
virtual	~AShape ()
virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable. More...
double	getFactorX2Y () const
double	getFactorX2Z () const
double	getFactorY2Z () const
double	getProportion () const
String	getParamName (int ipar) const
double	getParam (int ipar, int iarg) const
const ShapeParameter &	getParam (int ipar) const
void	setFactorX2Y (double factorX2Y)
void	setFactorX2Z (double factorX2Z)
void	setFactorY2Z (double factorY2Z)
void	setProportion (double proportion)
void	setParamName (int ipar, const String &name)
void	setParam (int ipar, int iarg, double value)
void	setParamDefault (int ipar, const String &name, double value)
void	setLaw (int ipar, ELaw law)
void	initParams (int count)
double	generateParam (int ipar) const
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

ShapeHalfSinusoid() [1/2]

ShapeHalfSinusoid::ShapeHalfSinusoid	(	double	proportion = 1.,
		double	period = 10.,
		double	amplitude = 1.,
		double	thickness = 1.,
		double	xext = 1.,
		double	zext = 1.,
		double	theta = 0.
	)

ShapeHalfSinusoid() [2/2]

ShapeHalfSinusoid::ShapeHalfSinusoid

(

const ShapeHalfSinusoid &

r

)

~ShapeHalfSinusoid()

ShapeHalfSinusoid::~ShapeHalfSinusoid ( )

virtual

Member Function Documentation

belongObject()

bool ShapeHalfSinusoid::belongObject ( const VectorDouble &  coor, const BooleanObject *  object  ) const

overridevirtual

Check if the pixel (x,y,z) belongs to the object

Returns

1 if the pixel is in the grain, 0 if it is in the pore

Implements AShape.

generateObject()

BooleanObject * ShapeHalfSinusoid::generateObject ( int  ndim = 3 )

overridevirtual

Generate the geometry of the object

Parameters

[in]

ndim

Space dimension

Implements AShape.

getFlagCutZ()

bool ShapeHalfSinusoid::getFlagCutZ ( ) const

inlineoverridevirtual

Implements AShape.

getNParams()

int ShapeHalfSinusoid::getNParams ( ) const

inlineoverridevirtual

Implements AShape.

getType()

EShape ShapeHalfSinusoid::getType ( ) const

inlineoverridevirtual

Interface for ICloneable.

Implements AShape.

operator=()

ShapeHalfSinusoid & ShapeHalfSinusoid::operator=

(

const ShapeHalfSinusoid &

r

)

---

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

• include/Boolean/ShapeHalfSinusoid.hpp
• src/Boolean/ShapeHalfSinusoid.cpp