Rationalised the named of uncoupled particle tracing solvers and functionObject
Solvers
icoUncoupledKinematicParcelFoam -> particleFoam
uncoupledKinematicParcelFoam -> rhoParticleFoam
functionObjects
icoUncoupledKinematicCloud -> particles
This commit is contained in:
Henry Weller
@ -1,4 +1,5 @@
|
||||
cloudInfo/cloudInfo.C
|
||||
dsmcFields/dsmcFields.C
|
||||
particles/particles.C
|
||||
|
||||
LIB = $(FOAM_LIBBIN)/liblagrangianFunctionObjects
|
||||
|
||||
144
src/functionObjects/lagrangian/particles/particles.C
Normal file
144
src/functionObjects/lagrangian/particles/particles.C
Normal file
@ -0,0 +1,144 @@
|
||||
/*---------------------------------------------------------------------------*\
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration | Website: https://openfoam.org
|
||||
\\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
|
||||
\\/ 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 "particles.H"
|
||||
#include "singlePhaseTransportModel.H"
|
||||
#include "addToRunTimeSelectionTable.H"
|
||||
|
||||
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
||||
|
||||
namespace Foam
|
||||
{
|
||||
namespace functionObjects
|
||||
{
|
||||
defineTypeNameAndDebug(particles, 0);
|
||||
addToRunTimeSelectionTable
|
||||
(
|
||||
functionObject,
|
||||
particles,
|
||||
dictionary
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
||||
|
||||
Foam::functionObjects::particles::particles
|
||||
(
|
||||
const word& name,
|
||||
const Time& runTime,
|
||||
const dictionary& dict
|
||||
)
|
||||
:
|
||||
fvMeshFunctionObject(name, runTime, dict),
|
||||
g_
|
||||
(
|
||||
IOobject
|
||||
(
|
||||
"g",
|
||||
time_.constant(),
|
||||
mesh_,
|
||||
IOobject::READ_IF_PRESENT,
|
||||
IOobject::NO_WRITE
|
||||
),
|
||||
dimensionedVector(dimAcceleration, Zero)
|
||||
),
|
||||
laminarTransport_
|
||||
(
|
||||
mesh_.lookupObject<singlePhaseTransportModel>("transportProperties")
|
||||
),
|
||||
rhoValue_
|
||||
(
|
||||
"rho",
|
||||
dimDensity,
|
||||
laminarTransport_
|
||||
),
|
||||
rho_
|
||||
(
|
||||
IOobject
|
||||
(
|
||||
"rho",
|
||||
time_.timeName(),
|
||||
mesh_
|
||||
),
|
||||
mesh_,
|
||||
rhoValue_
|
||||
),
|
||||
mu_("mu", rhoValue_*laminarTransport_.nu()),
|
||||
U_
|
||||
(
|
||||
mesh_.lookupObject<volVectorField>(dict.lookupOrDefault<word>("U", "U"))
|
||||
),
|
||||
kinematicCloudName_
|
||||
(
|
||||
dict.lookupOrDefault<word>("kinematicCloud", "kinematicCloud")
|
||||
),
|
||||
kinematicCloud_
|
||||
(
|
||||
kinematicCloudName_,
|
||||
rho_,
|
||||
U_,
|
||||
mu_,
|
||||
g_
|
||||
)
|
||||
{}
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
||||
|
||||
Foam::functionObjects::particles::~particles()
|
||||
{}
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
||||
|
||||
bool Foam::functionObjects::particles::read
|
||||
(
|
||||
const dictionary& dict
|
||||
)
|
||||
{
|
||||
fvMeshFunctionObject::read(dict);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
bool Foam::functionObjects::particles::execute()
|
||||
{
|
||||
mu_ = rhoValue_*laminarTransport_.nu();
|
||||
kinematicCloud_.evolve();
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
bool Foam::functionObjects::particles::write()
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
// ************************************************************************* //
|
||||
174
src/functionObjects/lagrangian/particles/particles.H
Normal file
174
src/functionObjects/lagrangian/particles/particles.H
Normal file
@ -0,0 +1,174 @@
|
||||
/*---------------------------------------------------------------------------*\
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration | Website: https://openfoam.org
|
||||
\\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
|
||||
\\/ 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::particles
|
||||
|
||||
Description
|
||||
This functionObject tracks a uncoupled kinematic particle cloud in the
|
||||
specified velocity field of an incompressible flow (laminar, RANS or LES).
|
||||
|
||||
It may be used in conjunction with any transient single-phase incompressible
|
||||
flow solver such as pisoFoam or pimpleFoam and tracks the particles or
|
||||
parcels without affecting the flow-field.
|
||||
|
||||
The kinematicCloud requires the density of the fluid which is looked-up
|
||||
from constant/transportProperties dictionary and the acceleration due to
|
||||
gravity which is read from the constant/g file if present or defaults to
|
||||
zero.
|
||||
|
||||
The kinematicCloud properties are read from the
|
||||
constant/kinematicCloudProperties dictionary in the usual manner.
|
||||
|
||||
Example of function object specification:
|
||||
\verbatim
|
||||
particles
|
||||
{
|
||||
libs ("liblagrangianFunctionObjects.so");
|
||||
type particles;
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Usage
|
||||
\table
|
||||
Property | Description | Required | Default value
|
||||
type | Type name: particles | yes |
|
||||
U | Name of the velocity field | no | U
|
||||
kinematicCloud | Name of the kinematicCloud | no | kinematicCloud
|
||||
\endtable
|
||||
|
||||
See also
|
||||
Foam::functionObjects::fvMeshFunctionObject
|
||||
|
||||
SourceFiles
|
||||
particles.C
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef functionObjects_particles_H
|
||||
#define functionObjects_particles_H
|
||||
|
||||
#include "fvMeshFunctionObject.H"
|
||||
#include "basicKinematicCollidingCloud.H"
|
||||
#include "volFieldsFwd.H"
|
||||
#include "uniformDimensionedFields.H"
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
namespace Foam
|
||||
{
|
||||
|
||||
class singlePhaseTransportModel;
|
||||
|
||||
namespace functionObjects
|
||||
{
|
||||
|
||||
/*---------------------------------------------------------------------------*\
|
||||
Class particles Declaration
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
class particles
|
||||
:
|
||||
public fvMeshFunctionObject
|
||||
{
|
||||
// Private member data
|
||||
|
||||
//- Optional acceleration due to gravity
|
||||
uniformDimensionedVectorField g_;
|
||||
|
||||
//- Reference to the laminar transport model
|
||||
const singlePhaseTransportModel& laminarTransport_;
|
||||
|
||||
//- Uniform density value
|
||||
dimensionedScalar rhoValue_;
|
||||
|
||||
//- Density field needed to construct kinematicCloud
|
||||
volScalarField rho_;
|
||||
|
||||
//- Dynamic viscosity field needed to construct kinematicCloud
|
||||
volScalarField mu_;
|
||||
|
||||
//- Reference to the velocity field
|
||||
const volVectorField& U_;
|
||||
|
||||
//- Name of the cloud
|
||||
word kinematicCloudName_;
|
||||
|
||||
//- The kinematic cloud
|
||||
basicKinematicCollidingCloud kinematicCloud_;
|
||||
|
||||
|
||||
public:
|
||||
|
||||
//- Runtime type information
|
||||
TypeName("particles");
|
||||
|
||||
|
||||
// Constructors
|
||||
|
||||
//- Construct for given objectRegistry and dictionary.
|
||||
// Allow the possibility to load fields from files
|
||||
particles
|
||||
(
|
||||
const word& name,
|
||||
const Time& runTime,
|
||||
const dictionary& dict
|
||||
);
|
||||
|
||||
//- Disallow default bitwise copy construction
|
||||
particles(const particles&) = delete;
|
||||
|
||||
|
||||
//- Destructor
|
||||
virtual ~particles();
|
||||
|
||||
|
||||
// Member Functions
|
||||
|
||||
//- Read the controls
|
||||
virtual bool read(const dictionary&);
|
||||
|
||||
//- Track the cloud
|
||||
virtual bool execute();
|
||||
|
||||
//- Write the cloud
|
||||
virtual bool write();
|
||||
|
||||
|
||||
// Member Operators
|
||||
|
||||
//- Disallow default bitwise assignment
|
||||
void operator==(const particles&) = delete;
|
||||
};
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
} // End namespace functionObjects
|
||||
} // End namespace Foam
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
#endif
|
||||
|
||||
// ************************************************************************* //
|
||||
Reference in New Issue
Block a user