 |
|
|
|
|
fieldAverage Class ReferenceCalculates the field averages given list of fieldAverageItems, e.g. More...
Collaboration diagram for fieldAverage:
Detailed DescriptionCalculates the field averages given list of fieldAverageItems, e.g.
fieldAverage1
{
// Type of functionObject
type fieldAverage;
// Where to load it from (if not already in solver)
functionObjectLibs ("libfieldAverage.so");
// Whether to perform a clean restart, or start from previous
// averaging info if available
cleanRestart true;
// Whether to reset the averaged fields after they have been written.
// Used to average over only the preceding write interval for transient
// cases.
resetOnOutput true;
// Fields to be averaged. runTime modifiable!
fields
(
U
{
mean on;
prime2Mean on;
base time;
}
p
{
mean on;
prime2Mean on;
base time;
}
);
Member function calcAverages() calculates the averages. Member function fieldAverage::write() calls calcAverages(). Average field names are constructed by concatenating the base field with the averaging type, e.g.
Information regarding the number of averaging steps, and total averaging time are written on a (base) per-field basis to the fieldAveragingProperties dictionary, located in <time>/uniform
Definition at line 105 of file fieldAverage.H. Constructor & Destructor Documentation
Disallow default bitwise copy construct.
Construct for given objectRegistry and dictionary. Allow the possibility to load fields from files Definition at line 290 of file fieldAverage.C.
Member Function Documentation
Checkout fields (causes deletion) from the database. and reset lists Definition at line 34 of file fieldAverage.C.
Reset lists (clear existing values) and initialize averaging. Check requested field averages are valid, populate field lists Definition at line 49 of file fieldAverage.C. Add mean average field to list.
Definition at line 26 of file fieldAverageTemplates.C. References Foam::endl(), fieldAverage::EXT_MEAN, fieldAverage::faItems_, HashTable< T, Key, Hash >::found(), objectRegistry::foundObject(), Foam::Info, objectRegistry::lookupObject(), Foam::nl, IOobject::NO_WRITE, word::null, fieldAverage::obr_, IOobject::READ_IF_PRESENT, regIOobject::store(), objectRegistry::time(), and Time::timeName().
Here is the call graph for this function:
Main calculation routine.
Definition at line 145 of file fieldAverage.C. Referenced by fieldAverage::end().
Here is the caller graph for this function:
Add mean-squared field value to prime-squared mean field.
Definition at line 232 of file fieldAverageTemplates.C.
Disallow default bitwise assignment.
Runtime type information.
Execute the averaging at the final time-loop, currently does nothing.
Definition at line 371 of file fieldAverage.C. References fieldAverage::active_, and fieldAverage::calcAverages().
Here is the call graph for this function:
Member Data Documentation
Mean average.
Definition at line 112 of file fieldAverage.H. Referenced by fieldAverage::addMeanField().
Database this class is registered to.
Definition at line 123 of file fieldAverage.H. Referenced by fieldAverage::addMeanField().
List of field average items, describing what averages to be. calculated and output Definition at line 141 of file fieldAverage.H. Referenced by fieldAverage::addMeanField().
Definition at line 146 of file fieldAverage.H.
Definition at line 147 of file fieldAverage.H.
Definition at line 148 of file fieldAverage.H.
Definition at line 149 of file fieldAverage.H.
Definition at line 150 of file fieldAverage.H.
Definition at line 154 of file fieldAverage.H.
Definition at line 155 of file fieldAverage.H.
The documentation for this class was generated from the following files:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||