OpenFOAM: parMapperHelper Class Reference

OpenFOAM v3.0plus

The open source CFD toolbox

Collaboration diagram for parMapperHelper:

Collaboration graph

[legend]

Public Member Functions
	parMapperHelper ()

	parMapperHelper (const point &p, const scalar &movingDst, const label globalLabel, const label patchLabel)

	~parMapperHelper ()

const point &	coordinates () const
	return point coordinates More...

const scalar &	movingDistance () const
	return moving distance More...

label	globalLabel () const
	return global label More...

label	pointPatch () const
	return patch the point is mapped to More...

void	operator= (const parMapperHelper &h)

bool	operator!= (const parMapperHelper &h) const

Private Attributes
point	p_

scalar	movingDist_

label	globalLabel_

label	patch_

Friends
Ostream &	operator<< (Ostream &os, const parMapperHelper &h)

Istream &	operator>> (Istream &is, parMapperHelper &h)

Detailed Description

Definition at line 51 of file parMapperHelper.H.

Constructor & Destructor Documentation

◆ parMapperHelper() [1/2]

parMapperHelper ( )

inlineexplicit

Definition at line 62 of file parMapperHelper.H.

◆ parMapperHelper() [2/2]

parMapperHelper	(	const point &	p,
		const scalar &	movingDst,
		const label	globalLabel,
		const label	patchLabel
	)

inlineexplicit

Definition at line 71 of file parMapperHelper.H.

◆ ~parMapperHelper()

~parMapperHelper ( )

inline

Definition at line 85 of file parMapperHelper.H.

Member Function Documentation

◆ coordinates()

const point& coordinates ( ) const

inline

return point coordinates

Definition at line 90 of file parMapperHelper.H.

References parMapperHelper::p_.

Referenced by meshSurfaceMapper::mapToSmallestDistance(), and meshSurfaceMapper2D::mapToSmallestDistance().

Here is the caller graph for this function:

◆ movingDistance()

const scalar& movingDistance ( ) const

inline

return moving distance

Definition at line 96 of file parMapperHelper.H.

References parMapperHelper::movingDist_.

Referenced by meshSurfaceMapper::mapToSmallestDistance(), and meshSurfaceMapper2D::mapToSmallestDistance().

Here is the caller graph for this function:

◆ globalLabel()

label globalLabel ( ) const

inline

return global label

Definition at line 102 of file parMapperHelper.H.

References parMapperHelper::globalLabel_.

Referenced by meshSurfaceMapper::mapToSmallestDistance(), and meshSurfaceMapper2D::mapToSmallestDistance().

Here is the caller graph for this function:

◆ pointPatch()

label pointPatch ( ) const

inline

return patch the point is mapped to

Definition at line 108 of file parMapperHelper.H.

References parMapperHelper::patch_.

◆ operator=()

void operator= ( const parMapperHelper & h )

inline

Definition at line 115 of file parMapperHelper.H.

References parMapperHelper::globalLabel_, Foam::constant::universal::h, parMapperHelper::movingDist_, parMapperHelper::p_, and parMapperHelper::patch_.

◆ operator!=()

bool operator!= ( const parMapperHelper & h ) const

inline

Definition at line 123 of file parMapperHelper.H.

References parMapperHelper::globalLabel_, and Foam::constant::universal::h.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	os,
		const parMapperHelper &	h
	)

friend

Definition at line 132 of file parMapperHelper.H.

◆ operator>>

Istream& operator>>	(	Istream &	is,
		parMapperHelper &	h
	)

friend

Definition at line 145 of file parMapperHelper.H.

Field Documentation

◆ p_

private

Definition at line 54 of file parMapperHelper.H.

Referenced by parMapperHelper::coordinates(), and parMapperHelper::operator=().

◆ movingDist_

scalar movingDist_

private

Definition at line 55 of file parMapperHelper.H.

Referenced by parMapperHelper::movingDistance(), and parMapperHelper::operator=().

◆ globalLabel_

label globalLabel_

private

Definition at line 56 of file parMapperHelper.H.

Referenced by parMapperHelper::globalLabel(), parMapperHelper::operator!=(), and parMapperHelper::operator=().

◆ patch_

label patch_

private

Definition at line 57 of file parMapperHelper.H.

Referenced by parMapperHelper::operator=(), and parMapperHelper::pointPatch().

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

applications/extra/cfMesh-v1.1.2/meshLibrary/utilities/surfaceTools/meshSurfaceMapper/parMapperHelper.H