Inheritance diagram for planeScaling:

Collaboration diagram for planeScaling:

[legend]

Public Member Functions
	TypeName ("plane")
	Runtime type information. More...

	planeScaling ()
	Null construct. More...

	planeScaling (const word &name, const point &original, const vector &normal, const scalar scalingDistance, const scalar scalingFactor)
	Construct from name, origin, normal, translation distance and scale. More...

	planeScaling (const word &name, const dictionary &dict)
	Construct from dictionary. More...

virtual autoPtr< coordinateModification >	clone (const planeScaling &pt) const
	Construct and return a clone. More...

virtual point	origin () const
	return the origin of the plane More...

virtual void	translateAndModifyObject (const vector &)

virtual vector	displacement (const point &) const
	calculate the displacement vector for plane translation More...

virtual vector	backwardDisplacement (const point &) const
	calculate the displacement vector for plane translation More...

virtual bool	combiningPossible () const
	can this modification object be combined with other ones More...

virtual void	boundingPlanes (PtrList< plane > &) const

dictionary	dict (bool ignoreType=false) const
	Return as dictionary of entries. More...

void	write (Ostream &) const
	Write. More...

void	writeDict (Ostream &, bool subDict=true) const
	Write dictionary. More...

void	operator= (const dictionary &)
	assign from dictionary More...

Ostream &	operator<< (Ostream &) const

Public Member Functions inherited from coordinateModification
	TypeName ("coordinateModification")

	coordinateModification ()
	Null construct. More...

	coordinateModification (const word &name, const dictionary &)
	Construct from dictionary. More...

	declareRunTimeSelectionTable (autoPtr, coordinateModification, dictionary,(const word &name, const dictionary &dict),(name, dict))

virtual	~coordinateModification ()

const word &	name () const
	Return name. More...

void	setName (const word &name)
	set the name More...

Private Attributes
point	origin_
	origin of the plane More...

vector	normal_
	normal vector More...

scalar	scalingDistance_
	scaling distance More...

scalar	scalingFactor_
	scaling factor More...

Friends
Ostream &	operator<< (Ostream &, const planeScaling &)

Additional Inherited Members
Static Public Member Functions inherited from coordinateModification
static autoPtr< coordinateModification >	New (const word &name, const dictionary &dict)
	Select constructed from dictionary. More...

Detailed Description

Definition at line 49 of file planeScaling.H.

Constructor & Destructor Documentation

◆ planeScaling() [1/3]

planeScaling ( )

Null construct.

Definition at line 46 of file planeScaling.C.

◆ planeScaling() [2/3]

planeScaling	(	const word &	name,
		const point &	original,
		const vector &	normal,
		const scalar	scalingDistance,
		const scalar	scalingFactor
	)

Construct from name, origin, normal, translation distance and scale.

Definition at line 56 of file planeScaling.C.

References Foam::endl(), Foam::name(), and Foam::Warning.

Here is the call graph for this function:

◆ planeScaling() [3/3]

planeScaling	(	const word &	name,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 82 of file planeScaling.C.

References dict.

Member Function Documentation

◆ TypeName()

TypeName ( "plane" )

Runtime type information.

◆ clone()

virtual autoPtr<coordinateModification> clone ( const planeScaling & pt ) const

inlinevirtual

Construct and return a clone.

Definition at line 92 of file planeScaling.H.

References coordinateModification::name(), planeScaling::normal_, planeScaling::origin_, planeScaling::scalingDistance_, and planeScaling::scalingFactor_.

Here is the call graph for this function:

◆ origin()

point origin ( ) const

virtual

return the origin of the plane

Implements coordinateModification.

Definition at line 94 of file planeScaling.C.

References planeScaling::origin_.

◆ translateAndModifyObject()

void translateAndModifyObject ( const vector & disp )

virtual

translate the object to the modified coordinates this is needed for backward transformation

Implements coordinateModification.

Definition at line 99 of file planeScaling.C.

References planeScaling::origin_, planeScaling::scalingDistance_, and planeScaling::scalingFactor_.

◆ displacement()

vector displacement ( const point & p ) const

virtual

calculate the displacement vector for plane translation

Implements coordinateModification.

Definition at line 106 of file planeScaling.C.

References Foam::max(), Foam::min(), planeScaling::normal_, planeScaling::origin_, p, planeScaling::scalingDistance_, and planeScaling::scalingFactor_.

Here is the call graph for this function:

◆ backwardDisplacement()

vector backwardDisplacement ( const point & p ) const

virtual

calculate the displacement vector for plane translation

Implements coordinateModification.

Definition at line 120 of file planeScaling.C.

References Foam::max(), Foam::min(), planeScaling::normal_, planeScaling::origin_, p, planeScaling::scalingDistance_, and planeScaling::scalingFactor_.

Here is the call graph for this function:

◆ combiningPossible()

bool combiningPossible ( ) const

virtual

can this modification object be combined with other ones

Implements coordinateModification.

Definition at line 134 of file planeScaling.C.

◆ boundingPlanes()

void boundingPlanes ( PtrList< plane > & pl ) const

virtual

return that "bounding planes" of the scaling region for the given object

Implements coordinateModification.

Definition at line 139 of file planeScaling.C.

References PtrList::clear(), Foam::mag(), planeScaling::normal_, planeScaling::origin_, planeScaling::scalingDistance_, planeScaling::scalingFactor_, PtrList::set(), and PtrList::setSize().

Here is the call graph for this function:

◆ dict()

dictionary dict ( bool ignoreType = false ) const

virtual

Return as dictionary of entries.

Implements coordinateModification.

Definition at line 156 of file planeScaling.C.

References dictionary::add(), planeScaling::normal_, planeScaling::origin_, planeScaling::scalingDistance_, planeScaling::scalingFactor_, and Foam::type().

Referenced by planeScaling::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Implements coordinateModification.

Definition at line 170 of file planeScaling.C.

References planeScaling::normal_, planeScaling::origin_, planeScaling::scalingDistance_, planeScaling::scalingFactor_, and Foam::type().

Referenced by planeScaling::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeDict()

void writeDict	(	Ostream &	os,
		bool	subDict = `true`
	)		const

virtual

Write dictionary.

Implements coordinateModification.

Definition at line 179 of file planeScaling.C.

References token::BEGIN_BLOCK, Foam::decrIndent(), token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::incrIndent(), Foam::indent(), Foam::nl, planeScaling::normal_, planeScaling::origin_, planeScaling::scalingDistance_, planeScaling::scalingFactor_, Foam::type(), and Ostream::writeKeyword().

Here is the call graph for this function:

◆ operator=()

void operator= ( const dictionary & d )

virtual

assign from dictionary

Implements coordinateModification.

Definition at line 205 of file planeScaling.C.

References planeScaling::dict(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, dictionary::found(), dictionary::lookup(), planeScaling::normal_, planeScaling::origin_, Foam::readScalar(), planeScaling::scalingDistance_, planeScaling::scalingFactor_, dictionary::subDict(), WarningIn, and Vector< scalar >::zero.

Here is the call graph for this function:

◆ operator<<()

Ostream & operator<< ( Ostream & os ) const

Definition at line 278 of file planeScaling.C.

References coordinateModification::name(), Foam::nl, and planeScaling::write().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	os,
		const planeScaling &	pt
	)

friend

Definition at line 285 of file planeScaling.C.

Field Documentation

◆ origin_

point origin_

private

origin of the plane

Definition at line 55 of file planeScaling.H.

Referenced by planeScaling::backwardDisplacement(), planeScaling::boundingPlanes(), planeScaling::clone(), planeScaling::dict(), planeScaling::displacement(), planeScaling::operator=(), planeScaling::origin(), planeScaling::translateAndModifyObject(), planeScaling::write(), and planeScaling::writeDict().

◆ normal_

vector normal_

private

normal vector

Definition at line 58 of file planeScaling.H.

Referenced by planeScaling::backwardDisplacement(), planeScaling::boundingPlanes(), planeScaling::clone(), planeScaling::dict(), planeScaling::displacement(), planeScaling::operator=(), planeScaling::write(), and planeScaling::writeDict().

◆ scalingDistance_

scalar scalingDistance_

private

scaling distance

Definition at line 61 of file planeScaling.H.

Referenced by planeScaling::backwardDisplacement(), planeScaling::boundingPlanes(), planeScaling::clone(), planeScaling::dict(), planeScaling::displacement(), planeScaling::operator=(), planeScaling::translateAndModifyObject(), planeScaling::write(), and planeScaling::writeDict().

◆ scalingFactor_

scalar scalingFactor_

private

scaling factor

Definition at line 64 of file planeScaling.H.

Referenced by planeScaling::backwardDisplacement(), planeScaling::boundingPlanes(), planeScaling::clone(), planeScaling::dict(), planeScaling::displacement(), planeScaling::operator=(), planeScaling::translateAndModifyObject(), planeScaling::write(), and planeScaling::writeDict().

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

applications/extra/cfMesh-v1.1.2/meshLibrary/utilities/anisotropicMeshing/coordinateModification/planeScaling.H
applications/extra/cfMesh-v1.1.2/meshLibrary/utilities/anisotropicMeshing/coordinateModification/planeScaling.C

Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ planeScaling() [1/3]

◆ planeScaling() [2/3]

◆ planeScaling() [3/3]

Member Function Documentation

◆ TypeName()

◆ clone()

◆ origin()

◆ translateAndModifyObject()

◆ displacement()

◆ backwardDisplacement()

◆ combiningPossible()

◆ boundingPlanes()

◆ dict()

◆ write()

◆ writeDict()

◆ operator=()

◆ operator<<()

Friends And Related Function Documentation

◆ operator<<

Field Documentation

◆ origin_

◆ normal_

◆ scalingDistance_

◆ scalingFactor_