Base class for field value -based function objects. More...
#include <fieldFunctionObjects/fieldValue.H>
Base class for field value -based function objects.
Definition at line 57 of file fieldValue.H.
Inheritance diagram for fieldValue: Collaboration diagram for fieldValue:Public Member Functions | |
| TypeName ("fieldValue") | |
| Run-time type information. | |
| fieldValue (const word &name, const objectRegistry &obr, const dictionary &dict, const bool loadFromFiles=false) | |
| Construct from components. | |
| virtual | ~fieldValue () |
| Destructor. | |
| const word & | name () const |
| Return the name of the geometric source. | |
| const objectRegistry & | obr () const |
| Return the reference to the object registry. | |
| bool | active () const |
| Return the active flag. | |
| const Switch & | log () const |
| Return the switch to send output to Info as well as to file. | |
| const word & | sourceName () const |
| Return the source name. | |
| const wordList & | fields () const |
| Return the list of field names. | |
| const Switch & | valueOutput () const |
| Return the output field values flag. | |
| const fvMesh & | mesh () const |
| Helper function to return the reference to the mesh. | |
| virtual void | read (const dictionary &dict) |
| Read from dictionary. | |
| virtual void | write () |
| Write to screen/file. | |
| virtual void | execute () |
| Execute. | |
| virtual void | end () |
| Execute the at the final time-loop, currently does nothing. | |
| template<class Type > | |
| tmp< Field< Type > > | combineFields (const Field< Type > &field) const |
| Comnbine fields from all processor domains into single field. | |
Protected Member Functions | |
| virtual void | makeFile () |
| Make the output file. | |
| virtual void | writeFileHeader ()=0 |
| Write the output file header. | |
| virtual void | updateMesh (const mapPolyMesh &) |
| Update mesh. | |
| virtual void | movePoints (const Field< point > &) |
| Move points. | |
Protected Attributes | |
| word | name_ |
| Name of this fieldValue object. | |
| const objectRegistry & | obr_ |
| Database this class is registered to. | |
| bool | active_ |
| Active flag. | |
| Switch | log_ |
| Switch to send output to Info as well as to file. | |
| word | sourceName_ |
| Name of source object. | |
| wordList | fields_ |
| List of field names to operate on. | |
| Switch | valueOutput_ |
| Output field values flag. | |
| autoPtr< OFstream > | outputFilePtr_ |
| Output file pointer. | |
| fieldValue | ( | const word & | name, |
| const objectRegistry & | obr, | ||
| const dictionary & | dict, | ||
| const bool | loadFromFiles = false |
||
| ) |
Construct from components.
Definition at line 127 of file fieldValue.C.
References Foam::endl(), Foam::nl, and WarningIn.
|
virtual |
Destructor.
Definition at line 168 of file fieldValue.C.
|
protectedvirtual |
Make the output file.
Definition at line 57 of file fieldValue.C.
References Foam::endl(), Foam::Info, Pstream::master(), Foam::mkDir(), Pstream::parRun(), fileName::path(), and Foam::type().
|
protectedpure virtual |
Write the output file header.
Implemented in faceSource, and cellSource.
|
protectedvirtual |
Update mesh.
Definition at line 45 of file fieldValue.C.
Move points.
Definition at line 51 of file fieldValue.C.
| TypeName | ( | "fieldValue" | ) |
Run-time type information.
|
inline |
Return the name of the geometric source.
Definition at line 30 of file fieldValueI.H.
References fieldValue::name_.
|
inline |
Return the reference to the object registry.
Definition at line 36 of file fieldValueI.H.
|
inline |
Return the active flag.
Definition at line 42 of file fieldValueI.H.
|
inline |
Return the switch to send output to Info as well as to file.
Definition at line 48 of file fieldValueI.H.
|
inline |
Return the source name.
Definition at line 54 of file fieldValueI.H.
|
inline |
Return the list of field names.
Definition at line 60 of file fieldValueI.H.
|
inline |
Return the output field values flag.
Definition at line 66 of file fieldValueI.H.
|
inline |
Helper function to return the reference to the mesh.
Definition at line 72 of file fieldValueI.H.
|
virtual |
Read from dictionary.
Reimplemented in faceSource, and cellSource.
Definition at line 99 of file fieldValue.C.
References dictionary::lookup(), and dictionary::lookupOrDefault().
Referenced by cellSource::read(), and faceSource::read().
|
virtual |
Write to screen/file.
Reimplemented in faceSource, and cellSource.
Definition at line 110 of file fieldValue.C.
References Foam::Info, Foam::nl, and Foam::type().
Referenced by cellSource::write(), and faceSource::write().
|
virtual |
Execute.
Definition at line 174 of file fieldValue.C.
|
virtual |
Execute the at the final time-loop, currently does nothing.
Definition at line 180 of file fieldValue.C.
| Foam::tmp< Foam::Field< Type > > combineFields | ( | const Field< Type > & | field | ) | const |
Comnbine fields from all processor domains into single field.
Definition at line 34 of file fieldValueTemplates.C.
|
protected |
Name of this fieldValue object.
Definition at line 65 of file fieldValue.H.
Referenced by fieldValue::name().
|
protected |
Database this class is registered to.
Definition at line 68 of file fieldValue.H.
Referenced by cellSource::validField(), and faceSource::validField().
|
protected |
Active flag.
Definition at line 71 of file fieldValue.H.
|
protected |
Switch to send output to Info as well as to file.
Definition at line 74 of file fieldValue.H.
|
protected |
Name of source object.
Definition at line 77 of file fieldValue.H.
|
protected |
List of field names to operate on.
Definition at line 80 of file fieldValue.H.
|
protected |
Output field values flag.
Definition at line 83 of file fieldValue.H.
Output file pointer.
Definition at line 86 of file fieldValue.H.
