polyMeshModifier Class Referenceabstract

Virtual base class for mesh modifiers. More...

Inheritance diagram for polyMeshModifier:
[legend]

Public Member Functions

 TypeName ("meshModifier")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, polyMeshModifier, dictionary,(const word &name, const dictionary &dict, const label index, const polyTopoChanger &mme),(name, dict, index, mme))
 
 polyMeshModifier (const word &name, const label index, const polyTopoChanger &mme, const bool act)
 Construct from components. More...
 
virtual ~polyMeshModifier ()=default
 Destructor. More...
 
const wordname () const
 Return name of this modifier. More...
 
label index () const
 Return the index of this modifier. More...
 
const polyTopoChangertopoChanger () const
 Return reference to morph engine. More...
 
virtual bool changeTopology () const =0
 Check for topology change. More...
 
virtual void setRefinement (polyTopoChange &) const =0
 Insert the topological change instructions. More...
 
virtual void modifyMotionPoints (pointField &motionPoints) const =0
 Modify motion points to comply with the topological change. More...
 
virtual void updateMesh (const mapPolyMesh &)=0
 Force recalculation of locally stored data on topological change. More...
 
Switch active () const
 If modifier activate? More...
 
void enable () const
 Activate mesh modifier. More...
 
void disable () const
 Activate mesh modifier. More...
 
virtual void write (Ostream &) const =0
 Write. More...
 
virtual void writeDict (Ostream &) const =0
 Write dictionary. More...
 

Static Public Member Functions

static autoPtr< polyMeshModifierNew (const word &name, const dictionary &dict, const label index, const polyTopoChanger &mme)
 Select constructed from dictionary. More...
 

Friends

Ostreamoperator<< (Ostream &, const polyMeshModifier &)
 

Detailed Description

Virtual base class for mesh modifiers.

Source files

Definition at line 68 of file polyMeshModifier.H.

Constructor & Destructor Documentation

◆ polyMeshModifier()

polyMeshModifier ( const word name,
const label  index,
const polyTopoChanger mme,
const bool  act 
)

Construct from components.

Definition at line 46 of file polyMeshModifier.C.

References Foam::name().

Here is the call graph for this function:

◆ ~polyMeshModifier()

virtual ~polyMeshModifier ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "meshModifier"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
polyMeshModifier  ,
dictionary  ,
(const word &name, const dictionary &dict, const label index, const polyTopoChanger &mme)  ,
(name, dict, index, mme)   
)

◆ New()

Foam::autoPtr< Foam::polyMeshModifier > New ( const word name,
const dictionary dict,
const label  index,
const polyTopoChanger mme 
)
static

Select constructed from dictionary.

Definition at line 34 of file polyMeshModifierNew.C.

References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), polyMeshModifier::index(), and polyMeshModifier::name().

Here is the call graph for this function:

◆ name()

const word & name ( ) const
inline

Return name of this modifier.

Definition at line 150 of file polyMeshModifier.H.

Referenced by polyMeshModifier::New(), and slidingInterface::slidingInterface().

Here is the caller graph for this function:

◆ index()

label index ( ) const
inline

Return the index of this modifier.

Definition at line 156 of file polyMeshModifier.H.

Referenced by polyMeshModifier::New().

Here is the caller graph for this function:

◆ topoChanger()

const Foam::polyTopoChanger & topoChanger ( ) const

Return reference to morph engine.

Definition at line 63 of file polyMeshModifier.C.

◆ changeTopology()

virtual bool changeTopology ( ) const
pure virtual

Check for topology change.

Implemented in attachDetach, layerAdditionRemoval, perfectInterface, setUpdater, and slidingInterface.

◆ setRefinement()

virtual void setRefinement ( polyTopoChange ) const
pure virtual

Insert the topological change instructions.

Implemented in attachDetach, layerAdditionRemoval, perfectInterface, setUpdater, and slidingInterface.

◆ modifyMotionPoints()

virtual void modifyMotionPoints ( pointField motionPoints) const
pure virtual

Modify motion points to comply with the topological change.

Implemented in attachDetach, layerAdditionRemoval, perfectInterface, setUpdater, and slidingInterface.

◆ updateMesh()

virtual void updateMesh ( const mapPolyMesh )
pure virtual

Force recalculation of locally stored data on topological change.

Implemented in attachDetach, layerAdditionRemoval, perfectInterface, setUpdater, and slidingInterface.

◆ active()

Switch active ( ) const
inline

If modifier activate?

Definition at line 180 of file polyMeshModifier.H.

◆ enable()

void enable ( ) const
inline

Activate mesh modifier.

Definition at line 186 of file polyMeshModifier.H.

◆ disable()

void disable ( ) const
inline

Activate mesh modifier.

Definition at line 192 of file polyMeshModifier.H.

◆ write()

virtual void write ( Ostream ) const
pure virtual

Write.

Implemented in attachDetach, layerAdditionRemoval, perfectInterface, setUpdater, and slidingInterface.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ writeDict()

virtual void writeDict ( Ostream ) const
pure virtual

Friends And Related Function Documentation

◆ operator<<

Ostream & operator<< ( Ostream ,
const polyMeshModifier  
)
friend

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