Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends
polyMeshModifier Class Referenceabstract

Virtual base class for mesh modifiers. More...

Inheritance diagram for polyMeshModifier:
Inheritance graph
[legend]
Collaboration diagram for polyMeshModifier:
Collaboration graph
[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 ()
 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...
 
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...
 

Static Public Member Functions

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

Private Member Functions

 polyMeshModifier (const polyMeshModifier &)
 Disallow default bitwise copy construct. More...
 
void operator= (const polyMeshModifier &)
 Disallow default bitwise assignment. More...
 

Private Attributes

word name_
 Name of modifier. More...
 
label index_
 Index of modifier. More...
 
const polyTopoChangertopoChanger_
 Reference to morph engine. More...
 
Switch active_
 Activation switch. More...
 

Friends

Ostreamoperator<< (Ostream &, const polyMeshModifier &)
 

Detailed Description

Virtual base class for mesh modifiers.

Source files

Definition at line 61 of file polyMeshModifier.H.

Constructor & Destructor Documentation

◆ polyMeshModifier() [1/2]

polyMeshModifier ( const polyMeshModifier )
private

Disallow default bitwise copy construct.

◆ polyMeshModifier() [2/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()

~polyMeshModifier ( )
virtual

Destructor.

Definition at line 63 of file polyMeshModifier.C.

Member Function Documentation

◆ operator=()

void operator= ( const polyMeshModifier )
private

Disallow default bitwise assignment.

◆ 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, Foam::Info, Foam::name(), and Foam::nl.

Referenced by polyTopoChanger::readModifiers().

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

◆ name()

const word& name ( ) const
inline

◆ index()

label index ( ) const
inline

Return the index of this modifier.

Definition at line 149 of file polyMeshModifier.H.

References polyMeshModifier::index_.

◆ topoChanger()

const Foam::polyTopoChanger & topoChanger ( ) const

◆ changeTopology()

virtual bool changeTopology ( ) const
pure virtual

Check for topology change.

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

◆ setRefinement()

virtual void setRefinement ( polyTopoChange ) const
pure virtual

Insert the topological change instructions.

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

◆ 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.

◆ updateMesh()

virtual void updateMesh ( const mapPolyMesh )
pure virtual

Force recalculation of locally stored data on topological change.

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

◆ active()

const Switch& active ( ) const
inline

Definition at line 172 of file polyMeshModifier.H.

References polyMeshModifier::active_.

◆ enable()

void enable ( ) const
inline

Activate mesh modifier.

Definition at line 178 of file polyMeshModifier.H.

References polyMeshModifier::active_.

◆ disable()

void disable ( ) const
inline

Activate mesh modifier.

Definition at line 184 of file polyMeshModifier.H.

References polyMeshModifier::active_.

◆ write()

virtual void write ( Ostream ) const
pure virtual

◆ writeDict()

virtual void writeDict ( Ostream ) const
pure virtual

Friends And Related Function Documentation

◆ operator<<

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

Field Documentation

◆ name_

word name_
private

Name of modifier.

Definition at line 66 of file polyMeshModifier.H.

Referenced by polyMeshModifier::name().

◆ index_

label index_
private

Index of modifier.

Definition at line 69 of file polyMeshModifier.H.

Referenced by polyMeshModifier::index().

◆ topoChanger_

const polyTopoChanger& topoChanger_
private

Reference to morph engine.

Definition at line 72 of file polyMeshModifier.H.

◆ active_

Switch active_
mutableprivate

Activation switch.

Definition at line 75 of file polyMeshModifier.H.

Referenced by polyMeshModifier::active(), polyMeshModifier::disable(), and polyMeshModifier::enable().


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