derivedFields Class Reference

Provide derived fields such as wallShearStress and yPlus. More...

Collaboration diagram for derivedFields:

Public Member Functions
	TypeName ("derivedFields")
	Runtime type information. More...
	derivedFields (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
	Construct for given objectRegistry and dictionary. More...
virtual	~derivedFields ()
const word &	name () const
	Return name of the set of derivedFields. More...
void	read (const dictionary &dict)
	Read the derivedFields data. More...
void	write ()
	Calculate the derivedFields and write. More...
void	execute ()
	Satisfy OutputFilterFunctionObject. More...
void	end ()
	Satisfy OutputFilterFunctionObject. More...
bool	timeSet ()
	Called when time was set at the end of the Time::operator++. More...
void	updateMesh (const mapPolyMesh &)
	Update for changes of mesh. More...
void	movePoints (const polyMesh &)
	Update for changes of mesh. More...

Private Member Functions
void	addWriter (derivedFieldWriter *writer)
	Add writer to active list. More...
	derivedFields (const derivedFields &)
	Disallow default bitwise copy construct. More...
void	operator= (const derivedFields &)
	Disallow default bitwise assignment. More...

Private Attributes
PtrList< derivedFieldWriter > *const	writers_
	Active writers, if any. More...
word	name_
	Name of this set of derivedFields,. More...
const objectRegistry &	obr_

Detailed Description

Provide derived fields such as wallShearStress and yPlus.

Optionally provides statistics: min, max & average

Member function derivedFields::write() writes derivedFields into the directory <timeDir>, e.g.

functions
(
  derivedFields1
  {
    // Type of functionObject
    type derivedFields;

    // Where to load it from (if not already in solver)
    functionObjectLibs ("derivedFields");

    // Flow region
    // Optional default = defaultRegion
    // region someWhere;

    // Dedicated dictionary
    // Optional defualt = ""
    dictionary "";

    // Write interval
    outputControl timeStep;
    outputInterval 1;
    
    // functionObject will be called.
    // Optional default = on
    enabled on;

    // Write fields on first start up (e.g., time zero)
    // Optional default = off
    writeOnStart on;

    wallShearStress 
    {
      // min, max & average to Info (optional default = off)
      statistics on;

      // Incompressible density reference (optional default = 1.)
      rhoInf 1.;
    }

    yPlus
    {
      statistics on;
    }               
  }
   );

Source files

• derivedFields.H
• derivedFields.C

Definition at line 107 of file derivedFields.H.

Constructor & Destructor Documentation

derivedFields() [1/2]

derivedFields ( const derivedFields &  )

private

Disallow default bitwise copy construct.

derivedFields() [2/2]

derivedFields	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const bool	loadFromFiles = false
	)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 59 of file derivedFields.C.

References dict, and derivedFields::read().

Here is the call graph for this function:

~derivedFields()

~derivedFields ( )

virtual

Definition at line 71 of file derivedFields.C.

Member Function Documentation

addWriter()

void addWriter ( derivedFieldWriter *  writer )

inlineprivate

Add writer to active list.

Definition at line 46 of file derivedFields.C.

References derivedFields::writers_.

operator=()

void operator= ( const derivedFields &  )

private

Disallow default bitwise assignment.

TypeName()

TypeName

(

"derivedFields"

)

Runtime type information.

name()

const word& name ( ) const

inline

Return name of the set of derivedFields.

Definition at line 153 of file derivedFields.H.

References derivedFields::name_.

read()

void read

(

const dictionary &

dict

)

Read the derivedFields data.

Definition at line 79 of file derivedFields.C.

References dict, Foam::endl(), dictionary::lookupOrDefault(), WarningIn, and write().

Referenced by derivedFields::derivedFields().

Here is the call graph for this function:

Here is the caller graph for this function:

write()

void write

(

)

Calculate the derivedFields and write.

Definition at line 110 of file derivedFields.C.

References forAll.

execute()

void execute ( )

inline

Satisfy OutputFilterFunctionObject.

Definition at line 165 of file derivedFields.H.

end()

void end ( )

inline

Satisfy OutputFilterFunctionObject.

Definition at line 169 of file derivedFields.H.

timeSet()

bool timeSet ( )

inline

Called when time was set at the end of the Time::operator++.

Definition at line 173 of file derivedFields.H.

updateMesh()

void updateMesh ( const mapPolyMesh &  )

inline

Update for changes of mesh.

Definition at line 177 of file derivedFields.H.

movePoints()

void movePoints ( const polyMesh &  )

inline

Update for changes of mesh.

Definition at line 181 of file derivedFields.H.

Field Documentation

writers_

PtrList<derivedFieldWriter>* const writers_

private

Active writers, if any.

Definition at line 112 of file derivedFields.H.

Referenced by derivedFields::addWriter().

name_

word name_

private

Name of this set of derivedFields,.

Definition at line 115 of file derivedFields.H.

Referenced by derivedFields::name().

obr_

const objectRegistry& obr_

private

Definition at line 117 of file derivedFields.H.

---

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

• src/postProcessing/functionObjects/derivedFields/derivedFields.H
• src/postProcessing/functionObjects/derivedFields/derivedFields.C