Public Member Functions | Static Public Member Functions | Private Attributes | Friends
coordinateModification Class Referenceabstract
Inheritance diagram for coordinateModification:
Inheritance graph
[legend]
Collaboration diagram for coordinateModification:
Collaboration graph
[legend]

Public Member Functions

 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 ()
 
virtual point origin () const =0
 return the origin point of the modification object More...
 
virtual void translateAndModifyObject (const vector &)=0
 translate the object for backward transformation More...
 
virtual vector displacement (const point &) const =0
 calculate the displacement vector for this modification More...
 
virtual vector backwardDisplacement (const point &) const =0
 calculate the displacement vector for the backward modification More...
 
virtual bool combiningPossible () const =0
 can this modification object be combined with other ones More...
 
virtual void boundingPlanes (PtrList< plane > &) const =0
 
const wordname () const
 Return name. More...
 
void setName (const word &name)
 set the name More...
 
virtual dictionary dict (bool ignoreType=false) const =0
 Return as dictionary of entries. More...
 
virtual void write (Ostream &) const =0
 Write. More...
 
virtual void writeDict (Ostream &, bool subDict=true) const =0
 Write dictionary. More...
 
virtual void operator= (const dictionary &)=0
 assign from dictionary More...
 

Static Public Member Functions

static autoPtr< coordinateModificationNew (const word &name, const dictionary &dict)
 Select constructed from dictionary. More...
 

Private Attributes

word name_
 Modification name. More...
 

Friends

Ostreamoperator<< (Ostream &, const coordinateModification &)
 

Detailed Description

Definition at line 55 of file coordinateModification.H.

Constructor & Destructor Documentation

◆ coordinateModification() [1/2]

Null construct.

Definition at line 40 of file coordinateModification.C.

◆ coordinateModification() [2/2]

coordinateModification ( const word name,
const dictionary  
)

Construct from dictionary.

Definition at line 47 of file coordinateModification.C.

◆ ~coordinateModification()

~coordinateModification ( )
virtual

Definition at line 57 of file coordinateModification.C.

Member Function Documentation

◆ TypeName()

TypeName ( "coordinateModification"  )

◆ declareRunTimeSelectionTable()

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

◆ New()

autoPtr< Foam::coordinateModification > New ( const word name,
const dictionary dict 
)
static

Select constructed from dictionary.

Definition at line 38 of file newCoordinateModification.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, dictionary::found(), Foam::Info, dictionary::lookup(), Foam::name(), and Foam::nl.

Referenced by checkMeshDict::checkAnisotropicSources(), and coordinateModifier::coordinateModifier().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ origin()

virtual point origin ( ) const
pure virtual

return the origin point of the modification object

Implemented in boxScaling, and planeScaling.

◆ translateAndModifyObject()

virtual void translateAndModifyObject ( const vector )
pure virtual

translate the object for backward transformation

Implemented in boxScaling, and planeScaling.

◆ displacement()

virtual vector displacement ( const point ) const
pure virtual

calculate the displacement vector for this modification

Implemented in boxScaling, and planeScaling.

◆ backwardDisplacement()

virtual vector backwardDisplacement ( const point ) const
pure virtual

calculate the displacement vector for the backward modification

Implemented in boxScaling, and planeScaling.

◆ combiningPossible()

virtual bool combiningPossible ( ) const
pure virtual

can this modification object be combined with other ones

Implemented in boxScaling, and planeScaling.

◆ boundingPlanes()

virtual void boundingPlanes ( PtrList< plane > &  ) const
pure virtual

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

Implemented in boxScaling, and planeScaling.

◆ name()

const word& name ( ) const
inline

◆ setName()

void setName ( const word name)
inline

set the name

Definition at line 136 of file coordinateModification.H.

References coordinateModification::name(), and coordinateModification::name_.

Here is the call graph for this function:

◆ dict()

virtual dictionary dict ( bool  ignoreType = false) const
pure virtual

Return as dictionary of entries.

Implemented in boxScaling, and planeScaling.

◆ write()

virtual void write ( Ostream ) const
pure virtual

Write.

Implemented in boxScaling, and planeScaling.

◆ writeDict()

virtual void writeDict ( Ostream ,
bool  subDict = true 
) const
pure virtual

Write dictionary.

Implemented in boxScaling, and planeScaling.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ operator=()

virtual void operator= ( const dictionary )
pure virtual

assign from dictionary

Implemented in boxScaling, and planeScaling.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream os,
const coordinateModification cm 
)
friend

Definition at line 63 of file coordinateModification.C.

Field Documentation

◆ name_

word name_
private

Modification name.

Definition at line 60 of file coordinateModification.H.

Referenced by coordinateModification::name(), and coordinateModification::setName().


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