Creates a size distribution via interrogating a continuous phase fraction field. More...
Public Member Functions | |
TypeName ("regionSizeDistribution") | |
Runtime type information. More... | |
regionSizeDistribution (const word &name, const Time &runTime, const dictionary &) | |
Construct for given objectRegistry and dictionary. More... | |
regionSizeDistribution (const regionSizeDistribution &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~regionSizeDistribution () |
virtual bool | read (const dictionary &) |
Read the regionSizeDistribution data. More... | |
virtual bool | execute () |
Do nothing. More... | |
virtual bool | write () |
Calculate the regionSizeDistribution and write. More... | |
void | operator= (const regionSizeDistribution &)=delete |
Disallow default bitwise assignment. More... | |
template<class Type > | |
Foam::Map< Type > | regionSum (const regionSplit ®ions, const Field< Type > &fld) const |
template<class Type > | |
Foam::List< Type > | extractData (const UList< label > &keys, const Map< Type > ®ionData) const |
Public Member Functions inherited from fvMeshFunctionObject | |
TypeName ("fvMeshFunctionObject") | |
Runtime type information. More... | |
fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~fvMeshFunctionObject () |
Destructor. More... | |
void | operator= (const fvMeshFunctionObject &)=delete |
Disallow default bitwise assignment. 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... | |
regionFunctionObject (const regionFunctionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~regionFunctionObject () |
Destructor. More... | |
void | operator= (const regionFunctionObject &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from functionObject | |
ClassName ("functionObject") | |
virtual const word & | type () 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< functionObject > | clone () const |
Return clone. More... | |
functionObject (const functionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~functionObject () |
Destructor. More... | |
const word & | name () const |
Return the name of this functionObject. More... | |
virtual bool | executeAtStart () const |
Return true if the functionObject should be executed at the start. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual bool | setTimeStep () |
Called by Time::setDeltaT(). Allows the functionObject to override. More... | |
virtual scalar | timeToNextWrite () |
Called by Time::adjustTimeStep(). Allows the functionObject to. 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... | |
void | operator= (const functionObject &)=delete |
Disallow default bitwise assignment. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from functionObject | |
static autoPtr< functionObject > | New (const word &name, const Time &, const dictionary &) |
Select from dictionary, based on its "type" entry. More... | |
Public Attributes inherited from functionObject | |
Switch | log |
Switch write log to Info. More... | |
Switch | executeAtStart_ |
Switch write log to Info. More... | |
Static Public Attributes inherited from functionObject | |
static bool | postProcess |
Global post-processing mode switch. 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 object from the objectRegistry. More... | |
template<class ObjectType > | |
ObjectType & | lookupObjectRef (const word &fieldName) |
Lookup non-const object reference from the objectRegistry. More... | |
template<class ObjectType > | |
bool | store (const tmp< ObjectType > &tfield) |
Store the given field in the objectRegistry. More... | |
template<class ObjectType > | |
bool | store (const 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 inherited from fvMeshFunctionObject | |
const fvMesh & | mesh_ |
Reference to the fvMesh. More... | |
Protected Attributes inherited from regionFunctionObject | |
const Time & | time_ |
Reference to the Time. More... | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
Creates a size distribution via interrogating a continuous phase fraction field.
Looks up a phase-fraction (alpha) field and splits the mesh into regions based on where the field is below the threshold value. These regions ("droplets") can now be analysed.
Regions:
Output (volume scalar) fields include:
Histogram:
Example of function object specification:
regionSizeDistribution1 { type regionSizeDistribution; libs ("libfieldFunctionObjects.so"); ... field alpha; patches (inlet); threshold 0.4; fields (p U); nBins 100; maxDiameter 0.5e-4; minDiameter 0; setFormat gnuplot; coordinateSystem { type cartesian; origin (0 0 0); e3 (0 1 1); e1 (1 0 0); } }
Property | Description | Required | Default value |
---|---|---|---|
type | type name: regionSizeDistribution | yes | |
field | phase field to interrogate | yes | |
patches | patches from which the liquid core is identified | yes | |
threshold | phase fraction applied to delimit regions | yes | |
fields | fields to sample | yes | |
nBins | number of bins for histogram | yes | |
maxDiameter | maximum region equivalent diameter | yes | |
minDiameter | minimum region equivalent diameter | no | 0 |
setFormat | writing format | yes | |
coordinateSystem | transformation for vector fields | no |
Definition at line 184 of file regionSizeDistribution.H.
regionSizeDistribution | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct for given objectRegistry and dictionary.
Allow the possibility to load fields from files
Definition at line 326 of file regionSizeDistribution.C.
References Foam::read().
Referenced by ListPlusEqOp< T, Size >::operator()().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Definition at line 343 of file regionSizeDistribution.C.
TypeName | ( | "regionSizeDistribution" | ) |
Runtime type information.
|
virtual |
Read the regionSizeDistribution data.
Reimplemented from regionFunctionObject.
Definition at line 349 of file regionSizeDistribution.C.
References Foam::endl(), format(), dictionary::found(), Foam::Info, dictionary::lookup(), writer< Type >::New(), and dictionary::readIfPresent().
|
virtual |
|
virtual |
Calculate the regionSizeDistribution and write.
Implements functionObject.
Definition at line 381 of file regionSizeDistribution.C.
References HashTable< T, label, Hash< label > >::begin(), HashTable< T, Key, Hash >::begin(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Foam::cbrt(), Field< Type >::component(), VectorSpace< Vector< scalar >, scalar, 3 >::componentNames, fvPatchField< Type >::coupled(), delta, Foam::dimless, Foam::fvc::domainIntegrate(), HashTableCore::end(), Foam::endl(), HashTable< T, label, Hash< label > >::erase(), HashTable< T, Key, Hash >::erase(), Foam::findStrings(), fld(), forAll, forAllConstIter(), forAllIter, HashTable< T, Key, Hash >::found(), Foam::gSum(), Foam::Info, HashTable< T, Key, Hash >::iteratorBase::key(), Foam::mag(), UPstream::master(), IOobject::MUST_READ, Foam::name(), IOobject::name(), VectorSpace< Vector< scalar >, scalar, 3 >::nComponents, Foam::nl, IOobject::NO_READ, IOobject::NO_WRITE, regionSplit::nRegions(), fvPatch::patch(), fvPatchField< Type >::patch(), patchi, fvPatchField< Type >::patchInternalField(), fvPatchField< Type >::patchNeighbourField(), Foam::constant::mathematical::pi(), Foam::pow(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), autoPtr< T >::reset(), List< T >::size(), HashTable< T, label, Hash< label > >::sortedToc(), polyPatch::start(), Foam::tab, Foam::type(), Field< Type >::typeName, autoPtr< T >::valid(), regIOobject::write(), and x.
|
delete |
Disallow default bitwise assignment.
Foam::Map<Type> regionSum | ( | const regionSplit & | regions, |
const Field< Type > & | fld | ||
) | const |
Definition at line 34 of file regionSizeDistributionTemplates.C.
References forAll, and regionSplit::nRegions().
Foam::List<Type> extractData | ( | const UList< label > & | keys, |
const Map< Type > & | regionData | ||
) | const |
Definition at line 65 of file regionSizeDistributionTemplates.C.
References forAll, and UList< T >::size().