File size: 4,824 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2018-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::age
Description
Calculates and writes out the time taken for a particle to travel from an
inlet to the location. Solves the following equation when incompressible:
\f[
\div (\phi t) = 1
\f]
where:
\vartable
t | Age [s]
\phi | Volumetric flux [m^3/s]
\endvartable
Boundary conditions are generated automatically as zeroGradient on all
walls and inletOutlet everywhere else.
Usage
\table
Property | Description | Required | Default value
phi | The name of the flux field | no | phi
rho | The name of the density field | no | rho
nCorr | The maximum number of correctors | no | 5
schemesField | The name of the field for the schemes | \\
no | age
solverField | The name of the field for the solver setting | \\
no | age
diffusion | Switch to turn on/off the diffusion term | no | off
tolerance | Solver residual control | no | 1e-5
\endtable
\verbatim
age1
{
type age;
libs ("libsolverFunctionObjects.so");
executeControl writeTime;
writeControl writeTime;
schemesField k;
solverField k;
}
\endverbatim
SourceFiles
age.C
\*---------------------------------------------------------------------------*/
#ifndef age_functionObject_H
#define age_functionObject_H
#include "fvMeshFunctionObject.H"
#include "volFields.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class age Declaration
\*---------------------------------------------------------------------------*/
class age
:
public fvMeshFunctionObject
{
// Private Data
//- The name of the flux field
word phiName_;
//- The name of the density field
word rhoName_;
//- Name of field from which schemes are taken
word schemesField_;
//- Name of field whose solver is used (optional)
word solverField_;
//- Switch to turn on/off the diffusion term
Switch diffusion_;
//- Convergence tolerance
scalar tolerance_;
// Private Member Functions
//- The list of patch types for the age field
wordList patchTypes() const;
//- Check convergence
bool converged(const int nCorr, const scalar initialResidual) const;
public:
//- Runtime type information
TypeName("age");
// Constructors
//- Construct from Time and dictionary
age
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Destructor
virtual ~age();
// Member Functions
//- Read the data
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const;
//- Do not execute at the start of the run
virtual bool executeAtStart() const
{
return false;
}
//- Execute
virtual bool execute();
//- Write
virtual bool write();
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|