mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: momentum field function (issue #1105)
Calculates linear/angular momentum, reporting integral values
and optionally writing the fields.
Example
momentum1
{
type momentum;
libs ("libfieldFunctionObjects.so");
...
writeMomentum yes;
writeVelocity no;
cylindrical true;
origin (0 0 0);
e1 (1 0 0);
e3 (0 0 1);
}
This commit is contained in:
Mark Olesen
@ -59,6 +59,7 @@ flowType/flowType.C
|
||||
CourantNo/CourantNo.C
|
||||
PecletNo/PecletNo.C
|
||||
blendingFactor/blendingFactor.C
|
||||
momentum/momentum.C
|
||||
pressure/pressure.C
|
||||
MachNo/MachNo.C
|
||||
Curle/Curle.C
|
||||
|
||||
573
src/functionObjects/field/momentum/momentum.C
Normal file
573
src/functionObjects/field/momentum/momentum.C
Normal file
@ -0,0 +1,573 @@
|
||||
/*---------------------------------------------------------------------------*\
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2018 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
This file is part of OpenFOAM.
|
||||
|
||||
OpenFOAM is free software: you can redistribute it and/or modify it
|
||||
under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
||||
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||||
for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#include "momentum.H"
|
||||
#include "fvMesh.H"
|
||||
#include "volFields.H"
|
||||
#include "cellSet.H"
|
||||
#include "cylindricalRotation.H"
|
||||
#include "addToRunTimeSelectionTable.H"
|
||||
|
||||
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
||||
|
||||
namespace Foam
|
||||
{
|
||||
namespace functionObjects
|
||||
{
|
||||
defineTypeNameAndDebug(momentum, 0);
|
||||
addToRunTimeSelectionTable(functionObject, momentum, dictionary);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
|
||||
|
||||
template<class GeoField>
|
||||
Foam::autoPtr<GeoField>
|
||||
Foam::functionObjects::momentum::newField
|
||||
(
|
||||
const word& baseName,
|
||||
const dimensionSet& dims,
|
||||
bool registerObject
|
||||
) const
|
||||
{
|
||||
return
|
||||
autoPtr<GeoField>::New
|
||||
(
|
||||
IOobject
|
||||
(
|
||||
scopedName(baseName),
|
||||
time_.timeName(),
|
||||
mesh_,
|
||||
IOobject::NO_READ,
|
||||
IOobject::NO_WRITE,
|
||||
registerObject
|
||||
),
|
||||
mesh_,
|
||||
dimensioned<typename GeoField::value_type>(dims, Zero)
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
void Foam::functionObjects::momentum::calc()
|
||||
{
|
||||
initialise();
|
||||
|
||||
// When field writing is not enabled we need our local storage
|
||||
// for the momentum and angular velocity fields
|
||||
autoPtr<volVectorField> tmomentum, tAngularMom, tAngularVel;
|
||||
|
||||
|
||||
// The base fields required
|
||||
const auto& U = lookupObject<volVectorField>(UName_);
|
||||
const auto* rhoPtr = findObject<volScalarField>(rhoName_);
|
||||
|
||||
const dimensionedScalar rhoRef("rho", dimDensity, rhoRef_);
|
||||
|
||||
// For quantities such as the mass-averaged angular velocity,
|
||||
// we would calculate the mass per-cell here.
|
||||
|
||||
// tmp<volScalarField::Internal> tmass =
|
||||
// (
|
||||
// rhoPtr
|
||||
// ? (mesh_.V() * (*rhoPtr))
|
||||
// : (mesh_.V() * rhoRef)
|
||||
// );
|
||||
|
||||
|
||||
// Linear momentum
|
||||
// ~~~~~~~~~~~~~~~
|
||||
|
||||
auto* pmomentum = getObjectPtr<volVectorField>(scopedName("momentum"));
|
||||
|
||||
if (!pmomentum)
|
||||
{
|
||||
tmomentum = newField<volVectorField>("momentum", dimVelocity*dimMass);
|
||||
pmomentum = tmomentum.get(); // get(), not release()
|
||||
}
|
||||
auto& momentum = *pmomentum;
|
||||
|
||||
if (rhoPtr)
|
||||
{
|
||||
momentum.ref() = (U * mesh_.V() * (*rhoPtr));
|
||||
}
|
||||
else
|
||||
{
|
||||
momentum.ref() = (U * mesh_.V() * rhoRef);
|
||||
}
|
||||
momentum.correctBoundaryConditions();
|
||||
|
||||
|
||||
// Angular momentum
|
||||
// ~~~~~~~~~~~~~~~~
|
||||
|
||||
auto* pAngularMom =
|
||||
getObjectPtr<volVectorField>(scopedName("angularMomentum"));
|
||||
|
||||
if (hasCsys_ && !pAngularMom)
|
||||
{
|
||||
tAngularMom =
|
||||
newField<volVectorField>("angularMomentum", dimVelocity*dimMass);
|
||||
pAngularMom = tAngularMom.get(); // get(), not release()
|
||||
}
|
||||
else if (!pAngularMom)
|
||||
{
|
||||
// Angular momentum not requested, but alias to normal momentum
|
||||
// to simplify logic when calculating the summations
|
||||
pAngularMom = pmomentum;
|
||||
}
|
||||
auto& angularMom = *pAngularMom;
|
||||
|
||||
|
||||
// Angular velocity
|
||||
// ~~~~~~~~~~~~~~~~
|
||||
|
||||
auto* pAngularVel =
|
||||
getObjectPtr<volVectorField>(scopedName("angularVelocity"));
|
||||
|
||||
if (hasCsys_)
|
||||
{
|
||||
if (!pAngularVel)
|
||||
{
|
||||
tAngularVel =
|
||||
newField<volVectorField>("angularVelocity", dimVelocity);
|
||||
pAngularVel = tAngularVel.get(); // get(), not release()
|
||||
}
|
||||
auto& angularVel = *pAngularVel;
|
||||
|
||||
|
||||
// Global to local
|
||||
|
||||
angularVel.primitiveFieldRef() =
|
||||
csys_.invTransform(mesh_.cellCentres(), U.internalField());
|
||||
|
||||
angularVel.correctBoundaryConditions();
|
||||
|
||||
if (rhoPtr)
|
||||
{
|
||||
angularMom.ref() = (angularVel * mesh_.V() * (*rhoPtr));
|
||||
}
|
||||
else
|
||||
{
|
||||
angularMom.ref() = (angularVel * mesh_.V() * rhoRef);
|
||||
}
|
||||
|
||||
angularMom.correctBoundaryConditions();
|
||||
}
|
||||
|
||||
|
||||
// Integrate the selection
|
||||
|
||||
sumMomentum_ = Zero;
|
||||
sumAngularMom_ = Zero;
|
||||
|
||||
switch (regionType_)
|
||||
{
|
||||
case vrtCellSet:
|
||||
case vrtCellZone:
|
||||
{
|
||||
for (const label celli : cellIDs())
|
||||
{
|
||||
sumMomentum_ += momentum[celli];
|
||||
sumAngularMom_ += angularMom[celli];
|
||||
}
|
||||
break;
|
||||
}
|
||||
case vrtAll:
|
||||
{
|
||||
for (label celli=0; celli < mesh_.nCells(); ++celli)
|
||||
{
|
||||
sumMomentum_ += momentum[celli];
|
||||
sumAngularMom_ += angularMom[celli];
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
reduce(sumMomentum_, sumOp<vector>());
|
||||
reduce(sumAngularMom_, sumOp<vector>());
|
||||
}
|
||||
|
||||
|
||||
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
|
||||
|
||||
void Foam::functionObjects::momentum::writeFileHeader(Ostream& os)
|
||||
{
|
||||
if (!writeToFile() || writtenHeader_)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (hasCsys_)
|
||||
{
|
||||
writeHeader(os, "Momentum, Angular Momentum");
|
||||
writeHeaderValue(os, "origin", csys_.origin());
|
||||
writeHeaderValue(os, "axis", csys_.e3());
|
||||
}
|
||||
else
|
||||
{
|
||||
writeHeader(os, "Momentum");
|
||||
}
|
||||
|
||||
if (regionType_ != vrtAll)
|
||||
{
|
||||
writeHeader
|
||||
(
|
||||
os,
|
||||
"Selection " + regionTypeNames_[regionType_]
|
||||
+ " = " + regionName_
|
||||
);
|
||||
}
|
||||
|
||||
writeHeader(os, "");
|
||||
writeCommented(os, "Time");
|
||||
writeTabbed(os, "(momentum_x momentum_y momentum_z)");
|
||||
|
||||
if (hasCsys_)
|
||||
{
|
||||
writeTabbed(os, "(momentum_r momentum_rtheta momentum_axis)");
|
||||
}
|
||||
os << endl;
|
||||
|
||||
|
||||
writtenHeader_ = true;
|
||||
}
|
||||
|
||||
|
||||
void Foam::functionObjects::momentum::initialise()
|
||||
{
|
||||
if (initialised_)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (!foundObject<volVectorField>(UName_))
|
||||
{
|
||||
FatalErrorInFunction
|
||||
<< "Could not find U: " << UName_ << " in database"
|
||||
<< exit(FatalError);
|
||||
}
|
||||
|
||||
|
||||
const auto* pPtr = cfindObject<volScalarField>(pName_);
|
||||
|
||||
if (pPtr && pPtr->dimensions() == dimPressure)
|
||||
{
|
||||
// Compressible - rho is mandatory
|
||||
|
||||
if (!foundObject<volScalarField>(rhoName_))
|
||||
{
|
||||
FatalErrorInFunction
|
||||
<< "Could not find rho:" << rhoName_
|
||||
<< exit(FatalError);
|
||||
}
|
||||
}
|
||||
|
||||
initialised_ = true;
|
||||
}
|
||||
|
||||
|
||||
void Foam::functionObjects::momentum::writeValues(Ostream& os)
|
||||
{
|
||||
Log << type() << " " << name() << " write:" << nl;
|
||||
|
||||
Log << " Sum of Momentum";
|
||||
|
||||
if (regionType_ != vrtAll)
|
||||
{
|
||||
Log << ' ' << regionTypeNames_[regionType_]
|
||||
<< ' ' << regionName_;
|
||||
}
|
||||
|
||||
Log << nl
|
||||
<< " linear : " << sumMomentum_ << nl;
|
||||
|
||||
if (hasCsys_)
|
||||
{
|
||||
Log << " angular : " << sumAngularMom_ << nl;
|
||||
}
|
||||
|
||||
if (writeToFile())
|
||||
{
|
||||
writeTime(os);
|
||||
|
||||
os << tab << sumMomentum_;
|
||||
|
||||
if (hasCsys_)
|
||||
{
|
||||
os << tab << sumAngularMom_;
|
||||
}
|
||||
os << endl;
|
||||
}
|
||||
|
||||
Log << endl;
|
||||
}
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
||||
|
||||
Foam::functionObjects::momentum::momentum
|
||||
(
|
||||
const word& name,
|
||||
const Time& runTime,
|
||||
const dictionary& dict,
|
||||
bool readFields
|
||||
)
|
||||
:
|
||||
fvMeshFunctionObject(name, runTime, dict),
|
||||
volRegion(fvMeshFunctionObject::mesh_, dict),
|
||||
writeFile(mesh_, name, typeName, dict),
|
||||
sumMomentum_(Zero),
|
||||
sumAngularMom_(Zero),
|
||||
UName_(),
|
||||
pName_(),
|
||||
rhoName_(),
|
||||
rhoRef_(1.0),
|
||||
csys_(),
|
||||
hasCsys_(false),
|
||||
writeMomentum_(false),
|
||||
writeVelocity_(false),
|
||||
writePosition_(false),
|
||||
initialised_(false)
|
||||
{
|
||||
if (readFields)
|
||||
{
|
||||
read(dict);
|
||||
Log << endl;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Foam::functionObjects::momentum::momentum
|
||||
(
|
||||
const word& name,
|
||||
const objectRegistry& obr,
|
||||
const dictionary& dict,
|
||||
bool readFields
|
||||
)
|
||||
:
|
||||
fvMeshFunctionObject(name, obr, dict),
|
||||
volRegion(fvMeshFunctionObject::mesh_, dict),
|
||||
writeFile(mesh_, name, typeName, dict),
|
||||
sumMomentum_(Zero),
|
||||
sumAngularMom_(Zero),
|
||||
UName_(),
|
||||
pName_(),
|
||||
rhoName_(),
|
||||
rhoRef_(1.0),
|
||||
csys_(),
|
||||
hasCsys_(false),
|
||||
writeMomentum_(false),
|
||||
writeVelocity_(false),
|
||||
writePosition_(false),
|
||||
initialised_(false)
|
||||
{
|
||||
if (readFields)
|
||||
{
|
||||
read(dict);
|
||||
Log << endl;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
||||
|
||||
bool Foam::functionObjects::momentum::read(const dictionary& dict)
|
||||
{
|
||||
fvMeshFunctionObject::read(dict);
|
||||
volRegion::read(dict);
|
||||
writeFile::read(dict);
|
||||
|
||||
initialised_ = false;
|
||||
|
||||
Info<< type() << " " << name() << ":" << nl;
|
||||
|
||||
// Optional entries U and p
|
||||
UName_ = dict.lookupOrDefault<word>("U", "U");
|
||||
pName_ = dict.lookupOrDefault<word>("p", "p");
|
||||
rhoName_ = dict.lookupOrDefault<word>("rho", "rho");
|
||||
rhoRef_ = dict.lookupOrDefault<scalar>("rhoRef", 1.0);
|
||||
|
||||
rhoRef_ = dict.lookupOrDefault<scalar>("rhoRef", 1.0);
|
||||
|
||||
hasCsys_ = dict.lookupOrDefault("cylindrical", false);
|
||||
|
||||
if (hasCsys_)
|
||||
{
|
||||
csys_ = coordSystem::cylindrical(dict);
|
||||
}
|
||||
|
||||
writeMomentum_ = dict.lookupOrDefault("writeMomentum", false);
|
||||
writeVelocity_ = dict.lookupOrDefault("writeVelocity", false);
|
||||
writePosition_ = dict.lookupOrDefault("writePosition", false);
|
||||
|
||||
Info<<"Integrating for selection: "
|
||||
<< regionTypeNames_[regionType_]
|
||||
<< " (" << regionName_ << ")" << nl;
|
||||
|
||||
if (writeMomentum_)
|
||||
{
|
||||
Info<< " Momentum fields will be written" << endl;
|
||||
|
||||
mesh_.objectRegistry::store
|
||||
(
|
||||
newField<volVectorField>("momentum", dimVelocity*dimMass)
|
||||
);
|
||||
|
||||
if (hasCsys_)
|
||||
{
|
||||
mesh_.objectRegistry::store
|
||||
(
|
||||
newField<volVectorField>("angularMomentum", dimVelocity*dimMass)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
if (hasCsys_)
|
||||
{
|
||||
if (writeVelocity_)
|
||||
{
|
||||
Info<< " Angular velocity will be written" << endl;
|
||||
|
||||
mesh_.objectRegistry::store
|
||||
(
|
||||
newField<volVectorField>("angularVelocity", dimVelocity)
|
||||
);
|
||||
}
|
||||
|
||||
if (writePosition_)
|
||||
{
|
||||
Info<< " Angular position will be written" << endl;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
bool Foam::functionObjects::momentum::execute()
|
||||
{
|
||||
calc();
|
||||
|
||||
if (Pstream::master())
|
||||
{
|
||||
writeFileHeader(file());
|
||||
|
||||
writeValues(file());
|
||||
|
||||
Log << endl;
|
||||
}
|
||||
|
||||
// Write state/results information
|
||||
setResult("momentum_x", sumMomentum_[0]);
|
||||
setResult("momentum_y", sumMomentum_[1]);
|
||||
setResult("momentum_z", sumMomentum_[2]);
|
||||
|
||||
setResult("momentum_r", sumAngularMom_[0]);
|
||||
setResult("momentum_rtheta", sumAngularMom_[1]);
|
||||
setResult("momentum_axis", sumAngularMom_[2]);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
bool Foam::functionObjects::momentum::write()
|
||||
{
|
||||
if (writeMomentum_ || (hasCsys_ && (writeVelocity_ || writePosition_)))
|
||||
{
|
||||
Log <<"Writing fields" << nl;
|
||||
|
||||
const volVectorField* fieldPtr;
|
||||
|
||||
fieldPtr = findObject<volVectorField>(scopedName("momentum"));
|
||||
if (fieldPtr) fieldPtr->write();
|
||||
|
||||
fieldPtr = findObject<volVectorField>(scopedName("angularMomentum"));
|
||||
if (fieldPtr) fieldPtr->write();
|
||||
|
||||
fieldPtr = findObject<volVectorField>(scopedName("angularVelocity"));
|
||||
if (fieldPtr) fieldPtr->write();
|
||||
|
||||
if (hasCsys_ && writePosition_)
|
||||
{
|
||||
// Clunky, but currently no simple means of handling
|
||||
// component-wise conversion and output
|
||||
|
||||
auto cyl_r = newField<volScalarField>("cyl_r", dimLength);
|
||||
auto cyl_t = newField<volScalarField>("cyl_theta", dimless);
|
||||
auto cyl_z = newField<volScalarField>("cyl_z", dimLength);
|
||||
|
||||
// Internal
|
||||
{
|
||||
const auto& pts = mesh_.cellCentres();
|
||||
const label len = pts.size();
|
||||
|
||||
UList<scalar>& r = cyl_r->primitiveFieldRef(false);
|
||||
UList<scalar>& t = cyl_t->primitiveFieldRef(false);
|
||||
UList<scalar>& z = cyl_z->primitiveFieldRef(false);
|
||||
|
||||
for (label i=0; i < len; ++i)
|
||||
{
|
||||
point p(csys_.localPosition(pts[i]));
|
||||
|
||||
r[i] = p.x();
|
||||
t[i] = p.y();
|
||||
z[i] = p.z();
|
||||
}
|
||||
}
|
||||
|
||||
// Boundary
|
||||
const polyBoundaryMesh& pbm = mesh_.boundaryMesh();
|
||||
|
||||
forAll(pbm, patchi)
|
||||
{
|
||||
const auto& pts = pbm[patchi].faceCentres();
|
||||
const label len = pts.size();
|
||||
|
||||
UList<scalar>& r = cyl_r->boundaryFieldRef(false)[patchi];
|
||||
UList<scalar>& t = cyl_t->boundaryFieldRef(false)[patchi];
|
||||
UList<scalar>& z = cyl_z->boundaryFieldRef(false)[patchi];
|
||||
|
||||
for (label i=0; i < len; ++i)
|
||||
{
|
||||
point p(csys_.localPosition(pts[i]));
|
||||
|
||||
r[i] = p.x();
|
||||
t[i] = p.y();
|
||||
z[i] = p.z();
|
||||
}
|
||||
}
|
||||
|
||||
cyl_r->write();
|
||||
cyl_t->write();
|
||||
cyl_z->write();
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
// ************************************************************************* //
|
||||
266
src/functionObjects/field/momentum/momentum.H
Normal file
266
src/functionObjects/field/momentum/momentum.H
Normal file
@ -0,0 +1,266 @@
|
||||
/*---------------------------------------------------------------------------*\
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2018 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
This file is part of OpenFOAM.
|
||||
|
||||
OpenFOAM is free software: you can redistribute it and/or modify it
|
||||
under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
||||
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||||
for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Class
|
||||
Foam::functionObjects::momentum
|
||||
|
||||
Group
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Calculates linear/angular momentum, reporting integral values
|
||||
and optionally writing the fields.
|
||||
|
||||
Data is written into momentum.dat in the
|
||||
postProcessing/\<functionObjectName\> directory.
|
||||
|
||||
Usage
|
||||
Example of function object specification:
|
||||
\verbatim
|
||||
momentum1
|
||||
{
|
||||
type momentum;
|
||||
libs ("libfieldFunctionObjects.so");
|
||||
...
|
||||
log yes;
|
||||
|
||||
regionType all;
|
||||
writeMomentum yes;
|
||||
writePosition yes;
|
||||
writeVelocity yes;
|
||||
|
||||
cylindrical true;
|
||||
|
||||
origin (0 0 0);
|
||||
e1 (1 0 0);
|
||||
e3 (0 0 1);
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Where the entries comprise:
|
||||
\table
|
||||
Property | Description | Required | Default
|
||||
type | Type name: momentum | yes |
|
||||
log | Log information to standard output | no | no
|
||||
writeMomentum | Write (linear, angular) momentum fields | no | no
|
||||
writePosition | Write angular position component fields | no | no
|
||||
writeVelocity | Write angular velocity fields | no | no
|
||||
p | Pressure field name | no | p
|
||||
U | Velocity field name | no | U
|
||||
rho | Density field name | no | rho
|
||||
rhoRef | Reference density (incompressible) | no | 1.0
|
||||
cylindrical | Use cylindrical coordinates | no | false
|
||||
origin | Origin for cylindrical coordinates | no |
|
||||
regionType | Selection type: all/cellSet/cellZone | no | all
|
||||
name | Name of cellSet/cellZone if required | no |
|
||||
\endtable
|
||||
|
||||
Note
|
||||
- For incompressible cases, the value of \c rhoRef is used.
|
||||
- When specifying the cylindrical coordinate system, the rotation
|
||||
can be specified directly with e1/e2/e3 axes, or via a \c rotation
|
||||
sub-dictionary
|
||||
For example,
|
||||
\verbatim
|
||||
origin (0 0 0);
|
||||
rotation
|
||||
{
|
||||
type cylindrical;
|
||||
axis (0 0 1);
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
See also
|
||||
Foam::functionObject
|
||||
Foam::functionObjects::fvMeshFunctionObject
|
||||
Foam::functionObjects::volRegion
|
||||
Foam::functionObjects::writeFile
|
||||
Foam::functionObjects::timeControl
|
||||
|
||||
SourceFiles
|
||||
momentum.C
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef functionObjects_momentum_H
|
||||
#define functionObjects_momentum_H
|
||||
|
||||
#include "fvMeshFunctionObject.H"
|
||||
#include "writeFile.H"
|
||||
#include "cylindricalCS.H"
|
||||
#include "volFieldsFwd.H"
|
||||
#include "volRegion.H"
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
namespace Foam
|
||||
{
|
||||
|
||||
// Forward declarations
|
||||
class dimensionSet;
|
||||
|
||||
namespace functionObjects
|
||||
{
|
||||
|
||||
/*---------------------------------------------------------------------------*\
|
||||
Class momentum Declaration
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
class momentum
|
||||
:
|
||||
public fvMeshFunctionObject,
|
||||
public volRegion,
|
||||
public writeFile
|
||||
{
|
||||
// Private Member Functions
|
||||
|
||||
//- Calculate the fields and integral values
|
||||
void calc();
|
||||
|
||||
//- Allocate a new zero geometric field
|
||||
template<class GeoField>
|
||||
autoPtr<GeoField> newField
|
||||
(
|
||||
const word& baseName,
|
||||
const dimensionSet& dims,
|
||||
bool registerObject=true
|
||||
) const;
|
||||
|
||||
|
||||
protected:
|
||||
|
||||
// Protected data
|
||||
|
||||
//- Integral (linear) momentum
|
||||
vector sumMomentum_;
|
||||
|
||||
//- Integral angular momentum
|
||||
vector sumAngularMom_;
|
||||
|
||||
|
||||
// Read from dictionary
|
||||
|
||||
//- The velocity field name (optional)
|
||||
word UName_;
|
||||
|
||||
//- The pressure field name (optional)
|
||||
// Only used to determine incompressible/compressible
|
||||
word pName_;
|
||||
|
||||
//- The density field name (optional)
|
||||
word rhoName_;
|
||||
|
||||
//- Reference density (for incompressible)
|
||||
scalar rhoRef_;
|
||||
|
||||
//- Coordinate system for evaluating angular momentum
|
||||
coordSystem::cylindrical csys_;
|
||||
|
||||
//- Are we using the cylindrical coordinate system?
|
||||
bool hasCsys_;
|
||||
|
||||
//- Write fields flag
|
||||
bool writeMomentum_;
|
||||
|
||||
//- Write fields flag
|
||||
bool writeVelocity_;
|
||||
|
||||
//- Write fields flag
|
||||
bool writePosition_;
|
||||
|
||||
//- Initialised flag
|
||||
bool initialised_;
|
||||
|
||||
|
||||
// Protected Member Functions
|
||||
|
||||
//- Initialise the fields
|
||||
void initialise();
|
||||
|
||||
//- Output file header information
|
||||
virtual void writeFileHeader(Ostream& os);
|
||||
|
||||
//- Write momentum data
|
||||
void writeValues(Ostream& os);
|
||||
|
||||
//- No copy construct
|
||||
momentum(const momentum&) = delete;
|
||||
|
||||
//- No copy assignment
|
||||
void operator=(const momentum&) = delete;
|
||||
|
||||
|
||||
public:
|
||||
|
||||
//- Runtime type information
|
||||
TypeName("momentum");
|
||||
|
||||
|
||||
// Constructors
|
||||
|
||||
//- Construct from Time and dictionary
|
||||
momentum
|
||||
(
|
||||
const word& name,
|
||||
const Time& runTime,
|
||||
const dictionary& dict,
|
||||
const bool readFields = true
|
||||
);
|
||||
|
||||
//- Construct from objectRegistry and dictionary
|
||||
momentum
|
||||
(
|
||||
const word& name,
|
||||
const objectRegistry& obr,
|
||||
const dictionary& dict,
|
||||
const bool readFields = true
|
||||
);
|
||||
|
||||
|
||||
//- Destructor
|
||||
virtual ~momentum() = default;
|
||||
|
||||
|
||||
// Member Functions
|
||||
|
||||
//- Read the momentum data
|
||||
virtual bool read(const dictionary&);
|
||||
|
||||
//- Calculate and report the integral momentum
|
||||
virtual bool execute();
|
||||
|
||||
//- Write the momentum, possibly angular momentum and velocity
|
||||
virtual bool write();
|
||||
};
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
} // End namespace functionObjects
|
||||
} // End namespace Foam
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
#endif
|
||||
|
||||
// ************************************************************************* //
|
||||
@ -48,6 +48,7 @@ runTimeModifiable true;
|
||||
functions
|
||||
{
|
||||
#include "coordinateTransform"
|
||||
#include "momentum"
|
||||
}
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
// -*- C++ -*-
|
||||
// Calculate momentum fields
|
||||
momentum
|
||||
{
|
||||
type momentum;
|
||||
libs ("libfieldFunctionObjects.so");
|
||||
log true;
|
||||
|
||||
executeInterval 10;
|
||||
writeControl writeTime;
|
||||
|
||||
// writeToFile true;
|
||||
|
||||
writeMomentum true;
|
||||
writePosition true;
|
||||
writeVelocity true;
|
||||
|
||||
// Cells to select (all/cellSet/cellZone)
|
||||
regionType all;
|
||||
// name c0;
|
||||
|
||||
cylindrical true;
|
||||
|
||||
origin (0 0 0);
|
||||
rotation
|
||||
{
|
||||
type cylindrical;
|
||||
axis (1 0 0); //< local Z
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// ************************************************************************* //
|
||||
Reference in New Issue
Block a user