Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
fieldValue Class Reference
Inheritance diagram for fieldValue:
Inheritance graph
[legend]
Collaboration diagram for fieldValue:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("fieldValue")
 Run-time type information. More...
 
 declareRunTimeSelectionTable (autoPtr, fieldValue, dictionary,(const word &name, const objectRegistry &obr, const dictionary &dict),(name, obr, dict))
 
 fieldValue (const word &name, const Time &runTime, const dictionary &dict, const word &valueType)
 Construct from Time and dictionary. More...
 
 fieldValue (const word &name, const objectRegistry &obr, const dictionary &dict, const word &valueType)
 Construct from objectRegistry and dictionary. More...
 
virtual ~fieldValue ()
 Destructor. More...
 
const dictionarydict () const
 Return the reference to the construction dictionary. More...
 
const wordregionName () const
 Return the region name. More...
 
const wordListfields () const
 Return the list of field names. More...
 
const SwitchwriteFields () const
 Return the output field values flag. More...
 
const fvMeshmesh () const
 Helper function to return the reference to the mesh. More...
 
const dictionaryresultDict () const
 Return access to the latest set of results. More...
 
virtual bool read (const dictionary &dict)
 Read from dictionary. More...
 
virtual bool execute ()
 Execute. More...
 
virtual bool write ()
 Write to screen/file. More...
 
- Public Member Functions inherited from writeFiles
 writeFiles (const word &name, const Time &time, const dictionary &dict, const word &prefix)
 Construct from name, Time, dictionary and prefix. More...
 
 writeFiles (const word &name, const objectRegistry &obr, const dictionary &dict, const word &prefix)
 Construct from name, objectRegistry, dictionary and prefix. More...
 
virtual ~writeFiles ()
 Destructor. More...
 
const wordListnames () const
 Return const access to the names. More...
 
OFstreamfile ()
 Return access to the file (if only 1) More...
 
PtrList< OFstream > & files ()
 Return access to the files. More...
 
OFstreamfile (const label i)
 Return file 'i'. More...
 
- Public Member Functions inherited from writeFile
 writeFile (const word &name, const Time &t, const dictionary &dict, const word &prefix)
 Construct from name, Time, dictionary and prefix. More...
 
 writeFile (const word &name, const objectRegistry &obr, const dictionary &dict, const word &prefix)
 Construct from name, objectRegistry, dictionary and prefix. More...
 
virtual ~writeFile ()
 Destructor. More...
 
void writeCommented (Ostream &os, const string &str) const
 Write a commented string to stream. More...
 
void writeTabbed (Ostream &os, const string &str) const
 Write a tabbed string to stream. More...
 
void writeHeader (Ostream &os, const string &str) const
 Write a commented header to stream. More...
 
void writeTime (Ostream &os) const
 Write the current time to stream. More...
 
template<class Type >
void writeHeaderValue (Ostream &os, const string &property, const Type &value) const
 Write a (commented) header property and value pair. More...
 
label charWidth () const
 Return width of character stream output. 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...
 
virtual ~regionFunctionObject ()
 Destructor. More...
 
- Public Member Functions inherited from 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)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual bool adjustTimeStep ()
 Called at the end of Time::adjustDeltaT() if adjustTime is true. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh. More...
 

Static Public Member Functions

static autoPtr< fieldValueNew (const word &name, const objectRegistry &obr, const dictionary &dict, const bool output=true)
 Return a reference to the selected fieldValue. More...
 
- 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...
 

Protected Member Functions

template<class Type >
void combineFields (Field< Type > &field)
 Combine fields from all processor domains into single field. More...
 
template<class Type >
void combineFields (tmp< Field< Type >> &)
 Combine fields from all processor domains into single field. More...
 
- Protected Member Functions inherited from writeFiles
virtual void createFiles ()
 Create the output file. More...
 
virtual void resetNames (const wordList &names)
 Reset the list of names from a wordList. More...
 
virtual void resetName (const word &name)
 Reset the list of names to a single name entry. More...
 
 writeFiles (const writeFiles &)
 Disallow default bitwise copy construct. More...
 
void operator= (const writeFiles &)
 Disallow default bitwise assignment. More...
 
- Protected Member Functions inherited from writeFile
virtual void initStream (Ostream &os) const
 Initialise the output stream for writing. More...
 
virtual fileName baseFileDir () const
 Return the base directory for output. More...
 
virtual fileName baseTimeDir () const
 Return the base directory for the current time value. More...
 
virtual void writeFileHeader (const label i=0)
 File header information. More...
 
virtual Omanip< int > valueWidth (const label offset=0) const
 Return the value width when writing to stream with optional offset. More...
 
 writeFile (const writeFile &)
 Disallow default bitwise copy construct. More...
 
void operator= (const writeFile &)
 Disallow default bitwise assignment. 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 >
const ObjectType & lookupObject (const word &fieldName) const
 Lookup field from the objectRegistry. More...
 
template<class ObjectType >
bool store (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

dictionary dict_
 Construction dictionary. More...
 
word regionName_
 Name of region (patch, zone, etc.) More...
 
wordList fields_
 List of field names to operate on. More...
 
Switch writeFields_
 Output field values flag. More...
 
dictionary resultDict_
 Results dictionary for external access of results. More...
 
- Protected Attributes inherited from writeFile
const word prefix_
 Prefix. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 

Additional Inherited Members

- Public Attributes inherited from functionObject
Switch log
 Switch write log to Info. More...
 
- Static Public Attributes inherited from writeFile
static const word outputPrefix
 Directory prefix. More...
 
static label addChars = 7
 Additional characters for writing. More...
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 Global post-processing mode switch. More...
 

Detailed Description

Definition at line 59 of file fieldValue.H.

Constructor & Destructor Documentation

fieldValue ( const word name,
const Time runTime,
const dictionary dict,
const word valueType 
)

Construct from Time and dictionary.

Definition at line 45 of file fieldValue.C.

References Foam::read().

Here is the call graph for this function:

fieldValue ( const word name,
const objectRegistry obr,
const dictionary dict,
const word valueType 
)

Construct from objectRegistry and dictionary.

Definition at line 63 of file fieldValue.C.

References Foam::read().

Here is the call graph for this function:

~fieldValue ( )
virtual

Destructor.

Definition at line 82 of file fieldValue.C.

Member Function Documentation

void combineFields ( Field< Type > &  field)
protected

Combine fields from all processor domains into single field.

Definition at line 33 of file fieldValueTemplates.C.

References Pstream::gatherList(), UPstream::master(), UPstream::myProcNo(), and UPstream::nProcs().

Referenced by fieldValue::combineFields().

Here is the call graph for this function:

Here is the caller graph for this function:

void combineFields ( tmp< Field< Type >> &  field)
protected

Combine fields from all processor domains into single field.

Definition at line 54 of file fieldValueTemplates.C.

References fieldValue::combineFields().

Here is the call graph for this function:

TypeName ( "fieldValue"  )

Run-time type information.

declareRunTimeSelectionTable ( autoPtr  ,
fieldValue  ,
dictionary  ,
(const word &name, const objectRegistry &obr, const dictionary &dict ,
(name, obr, dict  
)
Foam::autoPtr< Foam::functionObjects::fieldValue > New ( const word name,
const objectRegistry obr,
const dictionary dict,
const bool  output = true 
)
static

Return a reference to the selected fieldValue.

Definition at line 32 of file fieldValueNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), Foam::name(), and Foam::nl.

Referenced by fieldValueDelta::read().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::dictionary & dict ( ) const
inline

Return the reference to the construction dictionary.

Definition at line 31 of file fieldValueI.H.

References fieldValue::dict_.

const Foam::word & regionName ( ) const
inline

Return the region name.

Definition at line 37 of file fieldValueI.H.

References fieldValue::regionName_.

const Foam::wordList & fields ( ) const
inline

Return the list of field names.

Definition at line 43 of file fieldValueI.H.

References fieldValue::fields_.

const Foam::Switch & writeFields ( ) const
inline

Return the output field values flag.

Definition at line 50 of file fieldValueI.H.

References fieldValue::writeFields_.

const Foam::fvMesh & mesh ( ) const
inline

Helper function to return the reference to the mesh.

Definition at line 56 of file fieldValueI.H.

References regionFunctionObject::obr_.

const Foam::dictionary & resultDict ( ) const
inline

Return access to the latest set of results.

Definition at line 63 of file fieldValueI.H.

References fieldValue::resultDict_.

bool read ( const dictionary dict)
virtual

Read from dictionary.

Reimplemented from regionFunctionObject.

Reimplemented in surfaceRegion, and volRegion.

Definition at line 88 of file fieldValue.C.

References dict, dictionary::lookup(), and regionFunctionObject::read().

Referenced by volRegion::read(), and surfaceRegion::read().

Here is the call graph for this function:

Here is the caller graph for this function:

bool execute ( )
virtual

Execute.

Implements functionObject.

Definition at line 100 of file fieldValue.C.

bool write ( )
virtual

Write to screen/file.

Reimplemented from writeFiles.

Reimplemented in surfaceRegion, and volRegion.

Definition at line 106 of file fieldValue.C.

References Log, Foam::name(), Foam::nl, Foam::type(), and writeFiles::write().

Referenced by volRegion::write(), and surfaceRegion::write().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

dictionary dict_
protected

Construction dictionary.

Definition at line 69 of file fieldValue.H.

Referenced by fieldValue::dict().

word regionName_
protected

Name of region (patch, zone, etc.)

Definition at line 72 of file fieldValue.H.

Referenced by fieldValue::regionName().

wordList fields_
protected

List of field names to operate on.

Definition at line 75 of file fieldValue.H.

Referenced by fieldValue::fields().

Switch writeFields_
protected

Output field values flag.

Definition at line 78 of file fieldValue.H.

Referenced by fieldValue::writeFields().

dictionary resultDict_
protected

Results dictionary for external access of results.

Definition at line 81 of file fieldValue.H.

Referenced by fieldValue::resultDict().


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