Public Member Functions | Protected Member Functions | List of all members
syncObjects Class Reference

Copies content of local objectRegistry to all processors. More...

Inheritance diagram for syncObjects:
Inheritance graph
[legend]
Collaboration diagram for syncObjects:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("syncObjects")
 
 syncObjects (const word &name, const Time &runTime, const dictionary &dict)
 
virtual ~syncObjects ()=default
 
const objectRegistryobr () const
 
const fileNameroot () const
 
virtual bool read (const dictionary &)
 
virtual bool execute ()
 
virtual bool write ()
 
- 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)
 
autoPtr< functionObjectclone () const
 
virtual ~functionObject ()=default
 
virtual const wordtype () const =0
 
const wordname () const noexcept
 
bool useNamePrefix () const noexcept
 
bool useNamePrefix (bool on) noexcept
 
virtual bool execute (const label subIndex)
 
virtual bool end ()
 
virtual bool adjustTimeStep ()
 
virtual bool filesModified () const
 
virtual void updateMesh (const mapPolyMesh &mpm)
 
virtual void movePoints (const polyMesh &mesh)
 

Protected Member Functions

void sync ()
 
- Protected Member Functions inherited from functionObject
word scopedName (const word &name) const
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &runTime, const dictionary &dict)
 
- Public Attributes inherited from functionObject
bool log
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 
static bool defaultUseNamePrefix
 
static word outputPrefix
 

Detailed Description

Copies content of local objectRegistry to all processors.

Currently only supports IOFields. It is used to distribute IOFields from different processors/regions/worlds when doing loose coupling. To be used in combination with 'mapped' boundary conditions.

Usage
Example of function object specification:
syncObjects1
{
    type        syncObjects;
    libs        ("libutilityFunctionObjects.so");
    ...

    // Where is data located relative to runTime. Given as a filename
    // with every '/' indicating a sub-objectRegistry w.r.t. runTime.
    // Local data is under <root>/send/processorXXX. After execution
    // (potentially remote) data will be under the corresponding
    // <root>/receive/processorYYY objectRegistry.
    //root        "level0/level1/level2";
}

Where the entries comprise:

Property Description Required Default value
type type name: syncObjects yes
root relative location of data no ""
See also
Foam::functionObject
Source files

Definition at line 105 of file syncObjects.H.

Constructor & Destructor Documentation

◆ syncObjects()

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

Definition at line 48 of file syncObjects.C.

References dict, and Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ ~syncObjects()

virtual ~syncObjects ( )
virtualdefault

Member Function Documentation

◆ sync()

void sync ( )
protected

◆ TypeName()

TypeName ( "syncObjects"  )

◆ obr()

const objectRegistry& obr ( ) const
inline

Definition at line 158 of file syncObjects.H.

◆ root()

const fileName& root ( ) const
inline

Definition at line 163 of file syncObjects.H.

◆ read()

bool read ( const dictionary dict)
virtual

Reimplemented from functionObject.

Definition at line 166 of file syncObjects.C.

References Foam::expressions::patchExpr::debug, dict, Foam::endl(), fileName::null, Foam::Pout, functionObject::read(), and Foam::type().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Implements functionObject.

Definition at line 189 of file syncObjects.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::Pout, and Foam::type().

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Implements functionObject.

Definition at line 202 of file syncObjects.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::Pout, and Foam::type().

Here is the call graph for this function:

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