multiphaseEulerFoam::functionObjects: renamed moments and sizeDistribution

+ moments -> populationBalanceMoments
+ sizeDistribution -> populationBalanceSizeDistribution
This commit is contained in:
Henry Weller
2022-07-08 15:47:20 +01:00
parent ea3ef02883
commit 534ef0868c
7 changed files with 112 additions and 81 deletions

View File

@ -1,5 +1,5 @@
moments/moments.C
sizeDistribution/sizeDistribution.C
populationBalanceMoments/populationBalanceMoments.C
populationBalanceSizeDistribution/populationBalanceSizeDistribution.C
phaseForces/phaseForces.C
phaseMap/phaseMap.C

View File

@ -23,7 +23,7 @@ License
\*---------------------------------------------------------------------------*/
#include "moments.H"
#include "populationBalanceMoments.H"
#include "addToRunTimeSelectionTable.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
@ -32,8 +32,13 @@ namespace Foam
{
namespace functionObjects
{
defineTypeNameAndDebug(moments, 0);
addToRunTimeSelectionTable(functionObject, moments, dictionary);
defineTypeNameAndDebug(populationBalanceMoments, 0);
addToRunTimeSelectionTable
(
functionObject,
populationBalanceMoments,
dictionary
);
}
}
@ -43,7 +48,7 @@ namespace Foam
template<>
const char* NamedEnum
<
Foam::functionObjects::moments::momentType,
Foam::functionObjects::populationBalanceMoments::momentType,
4
>::names[] = {"integerMoment", "mean", "variance", "stdDev"};
}
@ -51,10 +56,10 @@ namespace Foam
const Foam::NamedEnum
<
Foam::functionObjects::moments::momentType,
Foam::functionObjects::populationBalanceMoments::momentType,
4
>
Foam::functionObjects::moments::momentTypeNames_;
Foam::functionObjects::populationBalanceMoments::momentTypeNames_;
namespace Foam
@ -62,7 +67,7 @@ namespace Foam
template<>
const char* NamedEnum
<
Foam::functionObjects::moments::coordinateType,
Foam::functionObjects::populationBalanceMoments::coordinateType,
3
>::names[] = {"volume", "area", "diameter"};
}
@ -70,10 +75,10 @@ namespace Foam
const Foam::NamedEnum
<
Foam::functionObjects::moments::coordinateType,
Foam::functionObjects::populationBalanceMoments::coordinateType,
3
>
Foam::functionObjects::moments::coordinateTypeNames_;
Foam::functionObjects::populationBalanceMoments::coordinateTypeNames_;
namespace Foam
@ -81,7 +86,7 @@ namespace Foam
template<>
const char* NamedEnum
<
Foam::functionObjects::moments::weightType,
Foam::functionObjects::populationBalanceMoments::weightType,
3
>::names[] =
{
@ -94,10 +99,10 @@ namespace Foam
const Foam::NamedEnum
<
Foam::functionObjects::moments::weightType,
Foam::functionObjects::populationBalanceMoments::weightType,
3
>
Foam::functionObjects::moments::weightTypeNames_;
Foam::functionObjects::populationBalanceMoments::weightTypeNames_;
namespace Foam
@ -105,7 +110,7 @@ namespace Foam
template<>
const char* NamedEnum
<
Foam::functionObjects::moments::meanType,
Foam::functionObjects::populationBalanceMoments::meanType,
3
>::names[] = {"arithmetic", "geometric", "notApplicable"};
}
@ -113,15 +118,16 @@ namespace Foam
const Foam::NamedEnum
<
Foam::functionObjects::moments::meanType,
Foam::functionObjects::populationBalanceMoments::meanType,
3
>
Foam::functionObjects::moments::meanTypeNames_;
Foam::functionObjects::populationBalanceMoments::meanTypeNames_;
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
Foam::word Foam::functionObjects::moments::coordinateTypeSymbolicName()
Foam::word
Foam::functionObjects::populationBalanceMoments::coordinateTypeSymbolicName()
{
word coordinateTypeSymbolicName(word::null);
@ -151,7 +157,8 @@ Foam::word Foam::functionObjects::moments::coordinateTypeSymbolicName()
}
Foam::word Foam::functionObjects::moments::weightTypeSymbolicName()
Foam::word
Foam::functionObjects::populationBalanceMoments::weightTypeSymbolicName()
{
word weightTypeSymbolicName(word::null);
@ -181,7 +188,7 @@ Foam::word Foam::functionObjects::moments::weightTypeSymbolicName()
}
Foam::word Foam::functionObjects::moments::defaultFldName()
Foam::word Foam::functionObjects::populationBalanceMoments::defaultFldName()
{
word meanName
(
@ -209,7 +216,8 @@ Foam::word Foam::functionObjects::moments::defaultFldName()
}
Foam::word Foam::functionObjects::moments::integerMomentFldName()
Foam::word
Foam::functionObjects::populationBalanceMoments::integerMomentFldName()
{
return
word
@ -229,7 +237,7 @@ Foam::word Foam::functionObjects::moments::integerMomentFldName()
}
void Foam::functionObjects::moments::setDimensions
void Foam::functionObjects::populationBalanceMoments::setDimensions
(
volScalarField& fld,
momentType momType
@ -385,7 +393,7 @@ void Foam::functionObjects::moments::setDimensions
Foam::tmp<Foam::volScalarField>
Foam::functionObjects::moments::totalConcentration()
Foam::functionObjects::populationBalanceMoments::totalConcentration()
{
tmp<volScalarField> tTotalConcentration
(
@ -456,7 +464,8 @@ Foam::functionObjects::moments::totalConcentration()
}
Foam::tmp<Foam::volScalarField> Foam::functionObjects::moments::mean()
Foam::tmp<Foam::volScalarField>
Foam::functionObjects::populationBalanceMoments::mean()
{
tmp<volScalarField> tMean
(
@ -582,7 +591,8 @@ Foam::tmp<Foam::volScalarField> Foam::functionObjects::moments::mean()
}
Foam::tmp<Foam::volScalarField> Foam::functionObjects::moments::variance()
Foam::tmp<Foam::volScalarField>
Foam::functionObjects::populationBalanceMoments::variance()
{
tmp<volScalarField> tVariance
(
@ -699,7 +709,7 @@ Foam::tmp<Foam::volScalarField> Foam::functionObjects::moments::variance()
Foam::tmp<Foam::volScalarField>
Foam::functionObjects::moments::stdDev()
Foam::functionObjects::populationBalanceMoments::stdDev()
{
switch (meanType_)
{
@ -717,7 +727,7 @@ Foam::functionObjects::moments::stdDev()
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::functionObjects::moments::moments
Foam::functionObjects::populationBalanceMoments::populationBalanceMoments
(
const word& name,
const Time& runTime,
@ -750,13 +760,14 @@ Foam::functionObjects::moments::moments
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
Foam::functionObjects::moments::~moments()
Foam::functionObjects::populationBalanceMoments::~populationBalanceMoments()
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
bool Foam::functionObjects::moments::read(const dictionary& dict)
bool
Foam::functionObjects::populationBalanceMoments::read(const dictionary& dict)
{
fvMeshFunctionObject::read(dict);
@ -872,7 +883,7 @@ bool Foam::functionObjects::moments::read(const dictionary& dict)
}
bool Foam::functionObjects::moments::execute()
bool Foam::functionObjects::populationBalanceMoments::execute()
{
switch (momentType_)
{
@ -961,7 +972,7 @@ bool Foam::functionObjects::moments::execute()
}
bool Foam::functionObjects::moments::write()
bool Foam::functionObjects::populationBalanceMoments::write()
{
writeObject(fldPtr_->name());

View File

@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::functionObjects::moments
Foam::functionObjects::populationBalanceMoments
Description
Calculates and writes out integral (integer moments) or mean properties
@ -34,9 +34,9 @@ Description
the phase fraction of the particulate phase:
\verbatim
moments
populationBalanceMoments
{
type moments;
type populationBalanceMoments;
libs ("libmultiphaseEulerFoamFunctionObjects.so");
executeControl timeStep;
writeControl writeTime;
@ -68,12 +68,12 @@ See also
Foam::functionObject
SourceFiles
moments.C
populationBalanceMoments.C
\*---------------------------------------------------------------------------*/
#ifndef functionObjects_moments_H
#define functionObjects_moments_H
#ifndef functionObjects_populationBalanceMoments_H
#define functionObjects_populationBalanceMoments_H
#include "fvMeshFunctionObject.H"
#include "populationBalanceModel.H"
@ -86,10 +86,10 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class moments Declaration
Class populationBalanceMoments Declaration
\*---------------------------------------------------------------------------*/
class moments
class populationBalanceMoments
:
public fvMeshFunctionObject
{
@ -200,13 +200,13 @@ private:
public:
//- Runtime type information
TypeName("moments");
TypeName("populationBalanceMoments");
// Constructors
//- Construct from Time and dictionary
moments
populationBalanceMoments
(
const word& name,
const Time& runTime,
@ -214,11 +214,11 @@ public:
);
//- Disallow default bitwise copy construction
moments(const moments&) = delete;
populationBalanceMoments(const populationBalanceMoments&) = delete;
//- Destructor
virtual ~moments();
virtual ~populationBalanceMoments();
// Member Functions
@ -242,7 +242,7 @@ public:
// Member Operators
//- Disallow default bitwise assignment
void operator=(const moments&) = delete;
void operator=(const populationBalanceMoments&) = delete;
};

View File

@ -23,7 +23,7 @@ License
\*---------------------------------------------------------------------------*/
#include "sizeDistribution.H"
#include "populationBalanceSizeDistribution.H"
#include "addToRunTimeSelectionTable.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
@ -32,8 +32,13 @@ namespace Foam
{
namespace functionObjects
{
defineTypeNameAndDebug(sizeDistribution, 0);
addToRunTimeSelectionTable(functionObject, sizeDistribution, dictionary);
defineTypeNameAndDebug(populationBalanceSizeDistribution, 0);
addToRunTimeSelectionTable
(
functionObject,
populationBalanceSizeDistribution,
dictionary
);
}
}
@ -41,7 +46,7 @@ template<>
const char*
Foam::NamedEnum
<
Foam::functionObjects::sizeDistribution::functionType,
Foam::functionObjects::populationBalanceSizeDistribution::functionType,
6
>::names[] =
{
@ -55,15 +60,15 @@ Foam::NamedEnum
const Foam::NamedEnum
<
Foam::functionObjects::sizeDistribution::functionType,
Foam::functionObjects::populationBalanceSizeDistribution::functionType,
6
> Foam::functionObjects::sizeDistribution::functionTypeNames_;
> Foam::functionObjects::populationBalanceSizeDistribution::functionTypeNames_;
template<>
const char*
Foam::NamedEnum
<
Foam::functionObjects::sizeDistribution::coordinateType,
Foam::functionObjects::populationBalanceSizeDistribution::coordinateType,
4
>::names[] =
{
@ -75,9 +80,10 @@ Foam::NamedEnum
const Foam::NamedEnum
<
Foam::functionObjects::sizeDistribution::coordinateType,
Foam::functionObjects::populationBalanceSizeDistribution::coordinateType,
4
> Foam::functionObjects::sizeDistribution::coordinateTypeNames_;
> Foam::functionObjects::populationBalanceSizeDistribution::
coordinateTypeNames_;
namespace Foam
@ -85,7 +91,7 @@ namespace Foam
template<>
const char* NamedEnum
<
Foam::functionObjects::sizeDistribution::weightType,
Foam::functionObjects::populationBalanceSizeDistribution::weightType,
4
>::names[] =
{
@ -99,17 +105,19 @@ namespace Foam
const Foam::NamedEnum
<
Foam::functionObjects::sizeDistribution::weightType,
Foam::functionObjects::populationBalanceSizeDistribution::weightType,
4
>
Foam::functionObjects::sizeDistribution::weightTypeNames_;
Foam::functionObjects::populationBalanceSizeDistribution::weightTypeNames_;
using Foam::constant::mathematical::pi;
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
Foam::word Foam::functionObjects::sizeDistribution::functionTypeSymbolicName()
Foam::word
Foam::functionObjects::populationBalanceSizeDistribution::
functionTypeSymbolicName()
{
word functionTypeSymbolicName(word::null);
@ -157,7 +165,9 @@ Foam::word Foam::functionObjects::sizeDistribution::functionTypeSymbolicName()
}
Foam::word Foam::functionObjects::sizeDistribution::coordinateTypeSymbolicName
Foam::word
Foam::functionObjects::populationBalanceSizeDistribution::
coordinateTypeSymbolicName
(
const coordinateType& cType
)
@ -197,7 +207,7 @@ Foam::word Foam::functionObjects::sizeDistribution::coordinateTypeSymbolicName
Foam::tmp<Foam::scalarField>
Foam::functionObjects::sizeDistribution::filterField
Foam::functionObjects::populationBalanceSizeDistribution::filterField
(
const scalarField& field
) const
@ -213,7 +223,8 @@ Foam::functionObjects::sizeDistribution::filterField
}
Foam::scalar Foam::functionObjects::sizeDistribution::averageCoordinateValue
Foam::scalar
Foam::functionObjects::populationBalanceSizeDistribution::averageCoordinateValue
(
const Foam::diameterModels::sizeGroup& fi,
const coordinateType& cType
@ -256,7 +267,8 @@ Foam::scalar Foam::functionObjects::sizeDistribution::averageCoordinateValue
}
Foam::scalar Foam::functionObjects::sizeDistribution::weightedAverage
Foam::scalar
Foam::functionObjects::populationBalanceSizeDistribution::weightedAverage
(
const Foam::scalarField& fld,
const Foam::diameterModels::sizeGroup& fi
@ -332,7 +344,8 @@ Foam::scalar Foam::functionObjects::sizeDistribution::weightedAverage
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::functionObjects::sizeDistribution::sizeDistribution
Foam::functionObjects::populationBalanceSizeDistribution::
populationBalanceSizeDistribution
(
const word& name,
const Time& runTime,
@ -379,13 +392,17 @@ Foam::functionObjects::sizeDistribution::sizeDistribution
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
Foam::functionObjects::sizeDistribution::~sizeDistribution()
Foam::functionObjects::populationBalanceSizeDistribution::
~populationBalanceSizeDistribution()
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
bool Foam::functionObjects::sizeDistribution::read(const dictionary& dict)
bool Foam::functionObjects::populationBalanceSizeDistribution::read
(
const dictionary& dict
)
{
Log << type() << " " << name() << ":" << nl;
@ -397,13 +414,13 @@ bool Foam::functionObjects::sizeDistribution::read(const dictionary& dict)
}
bool Foam::functionObjects::sizeDistribution::execute()
bool Foam::functionObjects::populationBalanceSizeDistribution::execute()
{
return true;
}
bool Foam::functionObjects::sizeDistribution::write()
bool Foam::functionObjects::populationBalanceSizeDistribution::write()
{
Log << type() << " " << name() << " write:" << nl;

View File

@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::functionObjects::sizeDistribution
Foam::functionObjects::populationBalanceSizeDistribution
Description
Writes out the size distribution determined by a population balance model,
@ -36,7 +36,7 @@ Description
\verbatim
numberDensity
{
type sizeDistribution;
type populationBalanceSizeDistribution;
libs ("libmultiphaseEulerFoamFunctionObjects.so");
writeControl writeTime;
populationBalance bubbles;
@ -71,12 +71,12 @@ See also
Foam::functionObject
SourceFiles
sizeDistribution.C
populationBalanceSizeDistribution.C
\*---------------------------------------------------------------------------*/
#ifndef sizeDistribution_H
#define sizeDistribution_H
#ifndef populationBalanceSizeDistribution_H
#define populationBalanceSizeDistribution_H
#include "fvMeshFunctionObject.H"
#include "volRegion.H"
@ -92,10 +92,10 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class sizeDistribution Declaration
Class populationBalanceSizeDistribution Declaration
\*---------------------------------------------------------------------------*/
class sizeDistribution
class populationBalanceSizeDistribution
:
public fvMeshFunctionObject,
public volRegion
@ -207,13 +207,13 @@ private:
public:
//- Runtime type information
TypeName("sizeDistribution");
TypeName("populationBalanceSizeDistribution");
// Constructors
//- Construct from Time and dictionary
sizeDistribution
populationBalanceSizeDistribution
(
const word& name,
const Time& runTime,
@ -221,11 +221,14 @@ public:
);
//- Disallow default bitwise copy construction
sizeDistribution(const sizeDistribution&) = delete;
populationBalanceSizeDistribution
(
const populationBalanceSizeDistribution&
) = delete;
//- Destructor
virtual ~sizeDistribution();
virtual ~populationBalanceSizeDistribution();
// Member Functions
@ -236,7 +239,7 @@ public:
return wordList::null();
}
//- Read the sizeDistribution data
//- Read the populationBalanceSizeDistribution data
virtual bool read(const dictionary&);
//- Execute, currently does nothing
@ -249,7 +252,7 @@ public:
// Member Operators
//- Disallow default bitwise assignment
void operator=(const sizeDistribution&) = delete;
void operator=(const populationBalanceSizeDistribution&) = delete;
};

View File

@ -12,7 +12,7 @@ Description
\*---------------------------------------------------------------------------*/
type moments;
type populationBalanceMoments;
libs ("libmultiphaseEulerFoamFunctionObjects.so");
populationBalance <populationBalance>;

View File

@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type sizeDistribution;
type populationBalanceSizeDistribution;
libs ("libmultiphaseEulerFoamFunctionObjects.so");
populationBalance <populationBalance>;