File size: 5,144 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2026 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 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 solvers or solver modules such as incompressibleFluid and tracks the
particles or parcels without affecting the flow-field.
The cloud requires the density of the fluid which is looked-up from
constant/phaseProperties dictionary and the acceleration due to gravity
which is read from the constant/g file if present or defaults to zero.
The cloud properties are read from the constant/\<cloudName\>Properties
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
cloud | Name of the cloud | no | cloud
\endtable
See also
Foam::functionObjects::fvMeshFunctionObject
SourceFiles
particles.C
\*---------------------------------------------------------------------------*/
#ifndef particles_functionObject_H
#define particles_functionObject_H
#include "fvMeshFunctionObject.H"
#include "parcelCloud.H"
#include "volFieldsFwd.H"
#include "uniformDimensionedFields.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class viscosityModel;
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class particles Declaration
\*---------------------------------------------------------------------------*/
class particles
:
public fvMeshFunctionObject
{
// Private Data
//- Optional acceleration due to gravity
uniformDimensionedVectorField g_;
//- Reference to the carrier fluid viscosity model
const viscosityModel& viscosity_;
//- Uniform density value
dimensionedScalar rhoValue_;
//- Density field needed to construct the cloud
volScalarField rho_;
//- Dynamic viscosity field needed to construct the cloud
volScalarField mu_;
//- Reference to the velocity field
const volVectorField& U_;
//- Name of the cloud
word cloudName_;
//- The cloud
autoPtr<parcelCloud> cloudPtr_;
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&);
//- Return the list of fields required
virtual wordList fields() const
{
return wordList::null();
}
//- 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
// ************************************************************************* //
|