patchCutLayerAverage Class Reference

This function object writes graphs of patch face values, area-averaged in planes perpendicular to a given direction. It adaptively grades the distribution of graph points to match the resolution of the mesh. More...

Inheritance diagram for patchCutLayerAverage:
Collaboration diagram for patchCutLayerAverage:

Public Member Functions

 TypeName ("patchCutLayerAverage")
 Runtime type information. More...
 
 patchCutLayerAverage (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
virtual ~patchCutLayerAverage ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the patchCutLayerAverage data. More...
 
virtual wordList fields () const
 Return the list of fields required. More...
 
virtual bool execute ()
 Execute, currently does nothing. More...
 
virtual bool write ()
 Write the patchCutLayerAverage. More...
 
virtual void movePoints (const polyMesh &)
 Update for mesh point-motion. More...
 
virtual void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > applyWeights (const List< weight > &weights, const Field< Type > &faceValues) const
 
- 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, const Time &runTime)
 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 scalar timeToNextAction ()
 Called by Time::adjustTimeStep(). Allows the functionObject to. More...
 
virtual scalar maxDeltaT () const
 Return the maximum time-step for stable operation. 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 fvMeshFunctionObject
labelHashSet patchSet (const dictionary &, const bool optional=false) const
 Return the patch set corresponding to the patch selection entries. 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...
 
void cannotFindObjects (const wordList &fieldNames)
 Prints a warning message that fieldNames 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 objectRegistryobr_
 Reference to the region objectRegistry. More...
 
- Protected Attributes inherited from functionObject
const Timetime_
 Reference to time. More...
 

Detailed Description

This function object writes graphs of patch face values, area-averaged in planes perpendicular to a given direction. It adaptively grades the distribution of graph points to match the resolution of the mesh.

Example of function object specification:

patchCutLayerAverage1
{
    type            patchCutLayerAverage;
    libs            ("libpatchCutLayerAverageFunctionObject.so");

    writeControl    writeTime;
    writeInterval   1;

    patch           lowerWall;
    direction       (1 0 0);
    nPoints         100;
    interpolate     no;

    fields          (p U);

    axis            x;
    setFormat       raw;
}
Usage
Property Description Required Default value
type type name: patchCutLayerAverage yes
patch Name of the patch yes
direction Axis along which to plot yes
nPoints Number of points in the plot yes
interpolate Do linear interpolation no false
fields Fields to plot values of yes
axis Component of the position to plot against yes
setFormat Format of the output file yes
Source files

Definition at line 137 of file patchCutLayerAverage.H.

Constructor & Destructor Documentation

◆ patchCutLayerAverage()

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

Construct from Time and dictionary.

Definition at line 620 of file patchCutLayerAverage.C.

References dict, and patchCutLayerAverage::read().

Here is the call graph for this function:

◆ ~patchCutLayerAverage()

~patchCutLayerAverage ( )
virtual

Destructor.

Definition at line 635 of file patchCutLayerAverage.C.

Member Function Documentation

◆ TypeName()

TypeName ( "patchCutLayerAverage"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the patchCutLayerAverage data.

Reimplemented from regionFunctionObject.

Definition at line 641 of file patchCutLayerAverage.C.

References coordSet::axisTypeNames_, coordSet::DEFAULT, dict, setWriter::New(), and Foam::normalised().

Referenced by patchCutLayerAverage::patchCutLayerAverage().

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

◆ fields()

Foam::wordList fields ( ) const
virtual

Return the list of fields required.

Implements functionObject.

Definition at line 671 of file patchCutLayerAverage.C.

◆ execute()

bool execute ( )
virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 677 of file patchCutLayerAverage.C.

◆ write()

◆ movePoints()

void movePoints ( const polyMesh mesh)
virtual

Update for mesh point-motion.

Reimplemented from functionObject.

Definition at line 775 of file patchCutLayerAverage.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap map)
virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 787 of file patchCutLayerAverage.C.

References polyTopoChangeMap::mesh().

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap map)
virtual

Update from another mesh using the given map.

Reimplemented from functionObject.

Definition at line 799 of file patchCutLayerAverage.C.

References polyMeshMap::mesh().

Here is the call graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap map)
virtual

Redistribute or update using the given distribution map.

Reimplemented from functionObject.

Definition at line 811 of file patchCutLayerAverage.C.

References polyDistributionMap::mesh().

Here is the call graph for this function:

◆ applyWeights()

Foam::tmp<Foam::Field<Type> > applyWeights ( const List< weight > &  weights,
const Field< Type > &  faceValues 
) const
inline

Definition at line 402 of file patchCutLayerAverage.C.

References forAll, Pstream::listCombineGather(), Pstream::listCombineScatter(), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

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