meshToMeshAdjustTimeStepFunctionObject Class Reference

Adjusts time-step for meshToMesh mapping. More...

Inheritance diagram for meshToMeshAdjustTimeStepFunctionObject:
Collaboration diagram for meshToMeshAdjustTimeStepFunctionObject:

Public Member Functions

 TypeName ("meshToMeshAdjustTimeStep")
 Runtime type information. More...
 
 meshToMeshAdjustTimeStepFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from components. More...
 
 meshToMeshAdjustTimeStepFunctionObject (const meshToMeshAdjustTimeStepFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~meshToMeshAdjustTimeStepFunctionObject ()
 
virtual bool read (const dictionary &)
 Read and reset the timeStep Function1. More...
 
virtual wordList fields () const
 Return the list of fields required. More...
 
virtual scalar timeToNextWrite ()
 Return the time to the next write. More...
 
virtual bool execute ()
 Do nothing. More...
 
virtual bool write ()
 Do nothing. More...
 
void operator= (const meshToMeshAdjustTimeStepFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 Runtime type information. More...
 
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fvMeshFunctionObject ()
 Destructor. More...
 
void operator= (const fvMeshFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 Runtime type information. More...
 
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
 regionFunctionObject (const regionFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~regionFunctionObject ()
 Destructor. More...
 
void operator= (const regionFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from functionObject
 ClassName ("functionObject")
 
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool executeAtStart () const
 Return true if the functionObject should be executed at the start. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update topology using the given map. More...
 
virtual void topoChange (const polyTopoChangeMap &map)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
void operator= (const functionObject &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &, const dictionary &)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
Switch log
 Switch write log to Info. More...
 
Switch executeAtStart_
 Switch write log to Info. More...
 
- Static Public Attributes inherited from functionObject
static bool postProcess
 Global post-processing mode switch. More...
 
- Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool foundObject (const word &fieldName) const
 Find field in the objectRegistry. More...
 
template<class ObjectType >
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 Lookup object from the objectRegistry. More...
 
template<class ObjectType >
ObjectType & lookupObjectRef (const word &fieldName)
 Lookup non-const object reference from the objectRegistry. More...
 
template<class ObjectType >
bool store (const tmp< ObjectType > &tfield)
 Store the given field in the objectRegistry. More...
 
template<class ObjectType >
bool store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 Store the given field in the objectRegistry under the given name. More...
 
bool writeObject (const word &fieldName)
 Write field if present in objectRegistry. More...
 
bool clearObject (const word &fieldName)
 Clear field from the objectRegistry if present. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ meshToMeshAdjustTimeStepFunctionObject() [1/2]

meshToMeshAdjustTimeStepFunctionObject ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from components.

Definition at line 51 of file meshToMeshAdjustTimeStepFunctionObject.C.

References meshToMeshAdjustTimeStepFunctionObject::~meshToMeshAdjustTimeStepFunctionObject().

Here is the call graph for this function:

◆ meshToMeshAdjustTimeStepFunctionObject() [2/2]

Disallow default bitwise copy construction.

◆ ~meshToMeshAdjustTimeStepFunctionObject()

Definition at line 68 of file meshToMeshAdjustTimeStepFunctionObject.C.

References meshToMeshAdjustTimeStepFunctionObject::read().

Referenced by meshToMeshAdjustTimeStepFunctionObject::meshToMeshAdjustTimeStepFunctionObject().

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

Member Function Documentation

◆ TypeName()

TypeName ( "meshToMeshAdjustTimeStep"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read and reset the timeStep Function1.

Reimplemented from regionFunctionObject.

Definition at line 75 of file meshToMeshAdjustTimeStepFunctionObject.C.

References regionFunctionObject::read().

Referenced by meshToMeshAdjustTimeStepFunctionObject::~meshToMeshAdjustTimeStepFunctionObject().

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

◆ fields()

◆ timeToNextWrite()

Foam::scalar timeToNextWrite ( )
virtual

Return the time to the next write.

Reimplemented from functionObject.

Definition at line 86 of file meshToMeshAdjustTimeStepFunctionObject.C.

References forAll, and UList< T >::last().

Referenced by meshToMeshAdjustTimeStepFunctionObject::fields().

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

◆ execute()

bool execute ( )
virtual

Do nothing.

Implements functionObject.

Definition at line 105 of file meshToMeshAdjustTimeStepFunctionObject.C.

Referenced by meshToMeshAdjustTimeStepFunctionObject::fields().

Here is the caller graph for this function:

◆ write()

bool write ( )
virtual

Do nothing.

Implements functionObject.

Definition at line 111 of file meshToMeshAdjustTimeStepFunctionObject.C.

Referenced by meshToMeshAdjustTimeStepFunctionObject::fields().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const meshToMeshAdjustTimeStepFunctionObject )
delete

Disallow default bitwise assignment.

Referenced by meshToMeshAdjustTimeStepFunctionObject::fields().

Here is the caller graph for this function:

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