gstlrn::Skin Class Reference

#include <Skin.hpp>

Public Member Functions
	Skin (const ISkinFunctions *skf, DbGrid *dbgrid=nullptr)
	Skin (const Skin &r)
Skin &	operator= (const Skin &r)
virtual	~Skin ()
Id	gridShift (Id lec, Id dir)
Id	init (bool verbose=false)
Id	remains (bool verbose=false)
void	getNext (Id *rank, Id *ipos)
Id	unstack (Id rank0, Id ipos0)
void	skinPrint () const

Constructor & Destructor Documentation

Skin() [1/2]

gstlrn::Skin::Skin	(	const ISkinFunctions *	skf,
		DbGrid *	dbgrid = nullptr
	)

Skin() [2/2]

gstlrn::Skin::Skin

(

const Skin &

r

)

~Skin()

gstlrn::Skin::~Skin ( )

virtual

Member Function Documentation

getNext()

void gstlrn::Skin::getNext	(	Id *	rank,
		Id *	ipos
	)

Find the next cell at random within the skin

Parameters

[out]	rank	Location of the cell in the skin
[out]	ipos	Cell location

gridShift()

Id gstlrn::Skin::gridShift	(	Id	lec,
		Id	dir
	)

Returns the shifted node of a skin

Returns

The absolute sample address

Parameters

[in]	lec	Absolute grid index of the input grid node
[in]	dir	Rank of the direction

init()

Id gstlrn::Skin::init

(

bool

verbose = false

)

Initialize the skin

Returns

Error returned code

Parameters

[in]

verbose

Verbose flag

operator=()

Skin & gstlrn::Skin::operator=

(

const Skin &

r

)

remains()

Id gstlrn::Skin::remains

(

bool

verbose = false

)

Returns the number of cells still to be processed

Returns

Returns the number of cells still to be processed

skinPrint()

void gstlrn::Skin::skinPrint

(

)

const

Print the computing information concerning the skin algorithm

unstack()

Id gstlrn::Skin::unstack	(	Id	rank0,
		Id	ipos0
	)

Suppress the current cell from the skin

Returns

Error return code

Parameters

[in]	rank0	Rank of the current cell in the skin
[in]	ipos0	Cell location

---

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

• include/Skin/Skin.hpp
• src/Skin/Skin.cpp