Public Member Functions | List of all members
writeFreeSurface Class Reference

A function object to write the control points on the free surface. More...

Inheritance diagram for writeFreeSurface:
[legend]
Collaboration diagram for writeFreeSurface:
[legend]

Public Member Functions

 TypeName ("writeFreeSurface")
 Runtime type information. More...
 
 writeFreeSurface (const word &name, const Time &runTime, const dictionary &dict)
 Construct from components. More...
 
virtual bool start ()
 start is called at the start of the time-loop More...
 
virtual bool execute ()
 execute is called at each ++ or += of the time-loop More...
 
virtual bool read (const dictionary &dict)
 Read and set the function object if its data has changed. More...
 
virtual bool write ()
 No-op. More...
 
- Public Member Functions inherited from functionObject
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
 Construct from components. More...
 
autoPtr< functionObject > clone () const
 Return clone. More...
 
virtual ~functionObject ()=default
 Destructor. More...
 
virtual const word & type () const =0
 Runtime type information. More...
 
const word & name () const noexcept
 Return the name of this functionObject. More...
 
bool useNamePrefix () const noexcept
 Return the flag for adding a scoping name prefix. More...
 
bool useNamePrefix (bool on) noexcept
 Modify the flag for adding a scoping name prefix. More...
 
virtual bool execute (const label subIndex)
 Execute using the specified subIndex. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual bool adjustTimeStep ()
 Called at the end of Time::adjustDeltaT() if adjustTime is true. More...
 
virtual bool filesModified () const
 Did any file get changed during execution? More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObject > New (const word &name, const Time &runTime, const dictionary &dict)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
bool log
 Flag to write log into Info. More...
 
- Static Public Attributes inherited from functionObject
static int debug
 Flag to execute debug content. More...
 
static bool postProcess
 Global post-processing mode switch. More...
 
static bool defaultUseNamePrefix
 Global default for useNamePrefix. More...
 
static word outputPrefix
 Directory prefix. More...
 
- Protected Member Functions inherited from functionObject
word scopedName (const word &name) const
 Return a scoped (prefixed) name. More...
 

Detailed Description

A function object to write the control points on the free surface.

Source files

Definition at line 53 of file writeFreeSurface.H.

Constructor & Destructor Documentation

◆ writeFreeSurface()

writeFreeSurface ( const word &  name,
const Time &  runTime,
const dictionary &  dict 
)

Construct from components.

Definition at line 75 of file writeFreeSurface.C.

References Foam::endl(), Foam::Info, Foam::name(), and dictionary::readIfPresent().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "writeFreeSurface"  )

Runtime type information.

◆ start()

bool start ( )
virtual

start is called at the start of the time-loop

Definition at line 94 of file writeFreeSurface.C.

References Foam::writeData().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

execute is called at each ++ or += of the time-loop

Implements functionObject.

Definition at line 100 of file writeFreeSurface.C.

References Foam::writeData().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary &  dict)
virtual

Read and set the function object if its data has changed.

Reimplemented from functionObject.

Definition at line 106 of file writeFreeSurface.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ write()

virtual bool write ( )
inlinevirtual

No-op.

Implements functionObject.

Definition at line 109 of file writeFreeSurface.H.

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