This function object calculates the magnitude of a field. The operation can be applied to any volume or surface fieldsm and the output is a volume or surface scalar field. More...
Public Member Functions | |
| TypeName ("calcMag") | |
| Runtime type information. | |
| calcMag (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false) | |
| Construct for given objectRegistry and dictionary. | |
| virtual | ~calcMag () |
| Destructor. | |
| virtual const word & | name () const |
| Return name of the set of calcMag. | |
| virtual void | read (const dictionary &) |
| Read the calcMag data. | |
| virtual void | execute () |
| Execute, currently does nothing. | |
| virtual void | end () |
| Execute at the final time-loop, currently does nothing. | |
| virtual void | write () |
| Calculate the calcMag and write. | |
| virtual void | updateMesh (const mapPolyMesh &) |
| Update for changes of mesh. | |
| virtual void | movePoints (const polyMesh &) |
| Update for changes of mesh. | |
Detailed Description
This function object calculates the magnitude of a field. The operation can be applied to any volume or surface fieldsm and the output is a volume or surface scalar field.
- Source files
Constructor & Destructor Documentation
| calcMag | ( | 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 42 of file calcMag.C.
References Foam::endl(), and WarningIn.
Member Function Documentation
| TypeName | ( | "calcMag" | ) |
Runtime type information.
| virtual const word& name | ( | ) | const [inline, virtual] |
| void read | ( | const dictionary & | dict | ) | [virtual] |
Read the calcMag data.
Definition at line 84 of file calcMag.C.
References dictionary::lookup().
| void execute | ( | ) | [virtual] |
| void end | ( | ) | [virtual] |
| void write | ( | ) | [virtual] |
Calculate the calcMag and write.
Definition at line 106 of file calcMag.C.
References Foam::endl(), and WarningIn.
| virtual void updateMesh | ( | const mapPolyMesh & | ) | [inline, virtual] |
| virtual void movePoints | ( | const polyMesh & | ) | [inline, virtual] |
The documentation for this class was generated from the following files:
- src/postProcessing/functionObjects/fvTools/calcMag/calcMag.H
- src/postProcessing/functionObjects/fvTools/calcMag/calcMag.C
- src/postProcessing/functionObjects/fvTools/calcMag/calcMagTemplates.C