File size: 3,841 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-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::fv::forcing
Description
Base fvModel for forcing functions.
See also
Foam::fv::isotropicDamping
Foam::fv::verticalDamping
SourceFiles
forcing.C
\*---------------------------------------------------------------------------*/
#ifndef forcing_H
#define forcing_H
#include "fvModel.H"
#include "DimensionedFunction1.H"
#include "volFields.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace fv
{
/*---------------------------------------------------------------------------*\
Class forcing Declaration
\*---------------------------------------------------------------------------*/
class forcing
:
public fvModel
{
protected:
// Protected Data
//- Optionally write the forcing fields
bool writeForceFields_;
//- Forcing coefficient [1/s]
mutable dimensionedScalar lambda_;
//- Optional boundary forcing coefficient [1/s]
mutable dimensionedScalar lambdaBoundary_;
//- The scaling function
autoPtr<DimensionedFunction1<scalar>> scale_;
//- Origins of the scaling coordinate
vectorField origins_;
//- Directions of increasing scaling coordinate
vectorField directions_;
// Protected Member Functions
//- Non-virtual read
void readCoeffs(const dictionary& dict);
//- Read the forcing coefficients
void readLambda(const dictionary& dict);
//- Calculate and return the volume average forcing region length
dimensionedScalar regionLength() const;
//- Return the scale distribution
virtual tmp<volInternalScalarField> scale() const;
//- Return the force coefficient
virtual tmp<volInternalScalarField> forceCoeff() const;
//- Optionally write the forcing fields:
// forcing:scale, forcing:forceCoeff
void writeForceFields() const;
public:
//- Runtime type information
TypeName("forcing");
// Constructors
//- Construct from components
forcing
(
const word& name,
const word& modelType,
const fvMesh& mesh,
const dictionary& dict
);
//- Destructor
virtual ~forcing()
{}
// Member Functions
//- Read dictionary
virtual bool read(const dictionary& dict);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace fv
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|