bitpit::PatchNumberingInfo Class Reference

Numbering information about the patch. More...

Inheritance diagram for bitpit::PatchNumberingInfo:

Collaboration diagram for bitpit::PatchNumberingInfo:

Public Member Functions
	PatchNumberingInfo (PatchKernel const *patch=nullptr)
long	getCellConsecutiveId (long id) const
const std::unordered_map< long, long > &	getCellConsecutiveMap () const
long	getCellConsecutiveOffset () const
long	getCellGlobalCount () const
long	getCellGlobalCountOffset () const
long	getCellGlobalCountOffset (int rank) const
long	getCellGlobalId (long id) const
const std::unordered_map< long, long > &	getCellGlobalMap () const
int	getCellOwnerFromConsecutive (long id) const
int	getCellOwnerFromGlobal (long id) const
int	getCellOwnerFromLocal (long id) const
Public Member Functions inherited from bitpit::PatchInfo
void	extract ()
PatchKernel const &	getPatch () const
void	reset ()
void	setPatch (PatchKernel const *patch)
void	update ()

Protected Member Functions
void	_extract () override
void	_init () override
void	_reset () override
Protected Member Functions inherited from bitpit::PatchInfo
	PatchInfo (PatchKernel const *patch)
void	setPatch (PatchKernel const *patch, bool initialize)

Additional Inherited Members
Protected Attributes inherited from bitpit::PatchInfo
PatchKernel const *	m_patch

Detailed Description

Numbering information about the patch.

Definition at line 60 of file patch_info.hpp.

Constructor & Destructor Documentation

PatchNumberingInfo()

bitpit::PatchNumberingInfo::PatchNumberingInfo

(

PatchKernel const *

patch = nullptr

)

Creates a new info.

Parameters

patch

is patch from which the informations will be extracted

Definition at line 138 of file patch_info.cpp.

Member Function Documentation

_extract()

void bitpit::PatchNumberingInfo::_extract ( )

overrideprotectedvirtual

Internal function to extract information from the patch.

Implements bitpit::PatchInfo.

Definition at line 172 of file patch_info.cpp.

_init()

void bitpit::PatchNumberingInfo::_init ( )

overrideprotectedvirtual

Internal function to initialize the information.

Implements bitpit::PatchInfo.

Definition at line 149 of file patch_info.cpp.

_reset()

void bitpit::PatchNumberingInfo::_reset ( )

overrideprotectedvirtual

Internal function to reset the information.

Implements bitpit::PatchInfo.

Definition at line 157 of file patch_info.cpp.

getCellConsecutiveId()

long bitpit::PatchNumberingInfo::getCellConsecutiveId

(

long

id

)

const

Return the consecutive id of the cell with the specified local id

Parameters

id	is the local id of the cell

Returns

The consecutive id of the specified cell.

Definition at line 302 of file patch_info.cpp.

getCellConsecutiveMap()

const std::unordered_map< long, long > & bitpit::PatchNumberingInfo::getCellConsecutiveMap

(

)

const

Return the map between local indexes and consecutive indexes.

Returns

The map between local indexes and consecutive indexes.

Definition at line 312 of file patch_info.cpp.

getCellConsecutiveOffset()

long bitpit::PatchNumberingInfo::getCellConsecutiveOffset

(

)

const

Return the consecutive offset for the local ells

Returns

The consecutive offset for the local cells.

Definition at line 291 of file patch_info.cpp.

getCellGlobalCount()

long bitpit::PatchNumberingInfo::getCellGlobalCount

(

)

const

Gets the global number of cells.

Returns

The global number of cells.

Definition at line 324 of file patch_info.cpp.

getCellGlobalCountOffset() [1/2]

long bitpit::PatchNumberingInfo::getCellGlobalCountOffset

(

)

const

Return the offset of the global cell count for the current parition.

Returns

The offset of the global cell count for the current parition.

Definition at line 339 of file patch_info.cpp.

getCellGlobalCountOffset() [2/2]

long bitpit::PatchNumberingInfo::getCellGlobalCountOffset

(

int

rank

)

const

Return the offset of the global cell count for the specified parition.

Parameters

rank	is the rank

Returns

The offset of the global cell count for the specified parition.

Definition at line 350 of file patch_info.cpp.

getCellGlobalId()

long bitpit::PatchNumberingInfo::getCellGlobalId

(

long

id

)

const

Return the global id of the cell with the specified local id

Parameters

id	is the local id of the cell

Returns

The global id of the specified cell.

Definition at line 366 of file patch_info.cpp.

getCellGlobalMap()

const std::unordered_map< long, long > & bitpit::PatchNumberingInfo::getCellGlobalMap

(

)

const

Return the map between local indexes and global indexes.

Returns

The map between local indexes and global indexes.

Definition at line 377 of file patch_info.cpp.

getCellOwnerFromConsecutive()

int bitpit::PatchNumberingInfo::getCellOwnerFromConsecutive

(

long

id

)

const

Gets the rank of the cell with the specified consecutive id

Parameters

id	is the consecutive id of the cell

Returns

The rank of the specified cell.

Definition at line 406 of file patch_info.cpp.

getCellOwnerFromGlobal()

int bitpit::PatchNumberingInfo::getCellOwnerFromGlobal

(

long

id

)

const

Gets the rank of the cell with the specified global id

Parameters

id	is the global id of the cell

Returns

The rank of the specified cell.

Definition at line 429 of file patch_info.cpp.

getCellOwnerFromLocal()

int bitpit::PatchNumberingInfo::getCellOwnerFromLocal

(

long

id

)

const

Gets the rank of the cell with the specified local id

Parameters

id	is the local id of the cell

Returns

The rank of the specified cell.

Definition at line 390 of file patch_info.cpp.

---

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

• src/patchkernel/patch_info.hpp
• src/patchkernel/patch_info.cpp