polyMeshModifier Class Referenceabstract

Virtual base class for mesh modifiers. More...

Inheritance diagram for polyMeshModifier:

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...
 
 polyMeshModifier (const polyMeshModifier &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~polyMeshModifier ()
 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 topoChange (const polyTopoChangeMap &)=0
 Force recalculation of locally stored data on topological change. More...
 
const Switchactive () const
 
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...
 
void operator= (const polyMeshModifier &)=delete
 Disallow default bitwise assignment. 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 69 of file polyMeshModifier.H.

Constructor & Destructor Documentation

◆ polyMeshModifier() [1/2]

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

Construct from components.

Definition at line 47 of file polyMeshModifier.C.

◆ polyMeshModifier() [2/2]

polyMeshModifier ( const polyMeshModifier )
delete

Disallow default bitwise copy construction.

◆ ~polyMeshModifier()

~polyMeshModifier ( )
virtual

Destructor.

Definition at line 63 of file polyMeshModifier.C.

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 32 of file polyMeshModifierNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, InfoInFunction, dictionary::lookup(), Foam::name(), and Foam::nl.

Here is the call graph for this function:

◆ name()

const word& name ( ) const
inline

Return name of this modifier.

Definition at line 145 of file polyMeshModifier.H.

Referenced by layerAdditionRemoval::modifyMotionPoints(), and attachDetach::modifyMotionPoints().

Here is the caller graph for this function:

◆ index()

label index ( ) const
inline

Return the index of this modifier.

Definition at line 151 of file polyMeshModifier.H.

References polyMeshModifier::changeTopology(), polyMeshModifier::modifyMotionPoints(), polyMeshModifier::setRefinement(), polyMeshModifier::topoChange(), and polyMeshModifier::topoChanger().

Here is the call graph for this function:

◆ topoChanger()

const Foam::polyTopoChanger & topoChanger ( ) const

Return reference to morph engine.

Definition at line 69 of file polyMeshModifier.C.

Referenced by polyMeshModifier::index().

Here is the caller graph for this function:

◆ changeTopology()

virtual bool changeTopology ( ) const
pure virtual

Check for topology change.

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

Referenced by polyMeshModifier::index().

Here is the caller graph for this function:

◆ setRefinement()

virtual void setRefinement ( polyTopoChange ) const
pure virtual

Insert the topological change instructions.

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

Referenced by polyMeshModifier::index().

Here is the caller graph for this function:

◆ modifyMotionPoints()

virtual void modifyMotionPoints ( pointField motionPoints) const
pure virtual

Modify motion points to comply with the topological change.

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

Referenced by polyMeshModifier::index().

Here is the caller graph for this function:

◆ topoChange()

virtual void topoChange ( const polyTopoChangeMap )
pure virtual

Force recalculation of locally stored data on topological change.

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

Referenced by polyMeshModifier::index().

Here is the caller graph for this function:

◆ active()

const Switch& active ( ) const
inline

Definition at line 174 of file polyMeshModifier.H.

◆ enable()

void enable ( ) const
inline

Activate mesh modifier.

Definition at line 180 of file polyMeshModifier.H.

◆ disable()

void disable ( ) const
inline

Activate mesh modifier.

Definition at line 186 of file polyMeshModifier.H.

References polyMeshModifier::operator<<, polyMeshModifier::operator=(), polyMeshModifier::write(), and polyMeshModifier::writeDict().

Here is the call graph for this function:

◆ write()

virtual void write ( Ostream ) const
pure virtual

Write.

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

Referenced by polyMeshModifier::disable(), and Foam::operator<<().

Here is the caller graph for this function:

◆ writeDict()

virtual void writeDict ( Ostream ) const
pure virtual

Write dictionary.

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

Referenced by polyMeshModifier::disable().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const polyMeshModifier )
delete

Disallow default bitwise assignment.

Referenced by polyMeshModifier::disable().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

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