File size: 7,719 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 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2025 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::forcesBase
Description
Calculates the forces and moments by integrating the pressure and
skin-friction forces over a given list of patches.
See also
Foam::functionObject
Foam::functionObjects::fvMeshFunctionObject
Foam::functionObjects::logFiles
Foam::functionObjects::timeControl
SourceFiles
forcesBase.C
\*---------------------------------------------------------------------------*/
#ifndef forcesBase_functionObject_H
#define forcesBase_functionObject_H
#include "fvMeshFunctionObject.H"
#include "logFiles.H"
#include "volFields.H"
#include "HashSet.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class forcesBase Declaration
\*---------------------------------------------------------------------------*/
class forcesBase
:
public fvMeshFunctionObject,
public logFiles
{
protected:
// Protected data
//- Enumeration for ensuring the right file is accessed
enum class fileID
{
mainFile = 0,
binsFile = 1
};
//- Pressure, viscous and porous force per bin
List<Field<vector>> force_;
//- Pressure, viscous and porous moment per bin
List<Field<vector>> moment_;
// Read from dictionary
//- Patches to integrate forces over
labelHashSet patchSet_;
//- Name of pressure field
word pName_;
//- Name of velocity field
word UName_;
//- Name of density field (optional)
word rhoName_;
//- The name of the phase (optional)
word phaseName_;
//- Is the force density being supplied directly?
Switch directForceDensity_;
//- The name of the force density (fD) field
word fDName_;
//- Reference density needed for incompressible calculations
scalar rhoRef_;
//- Reference pressure
scalar pRef_;
//- Flag to include porosity effects
bool porosity_;
// Bin information
//- Number of bins
label nBin_;
//- Direction used to determine bin orientation
vector binDir_;
//- Distance between bin divisions
scalar binDx_;
//- Minimum bin bounds
scalar binMin_;
//- Bin positions along binDir
List<point> binPoints_;
//- Should bin data be cumulative?
bool binCumulative_;
//- Initialised flag
bool initialised_;
// Protected Member Functions
using logFiles::file;
Ostream& file(const fileID fid)
{
return logFiles::file(label(fid));
}
//- Create file names for forces and bins
wordList createFileNames(const dictionary& dict) const;
//- Output file header information
virtual void writeFileHeader(const label i);
//- Initialise the fields
void initialise();
//- Return rhoRef if the pressure field is dynamic, i.e. p/rho
// otherwise return 1
scalar rho(const volScalarField& p) const;
//- Get the volume fraction field
tmp<volScalarField> alpha() const;
//- Get the volume fraction field on a patch
tmp<scalarField> alpha(const label patchi) const;
//- Accumulate bin data
void applyBins
(
const vectorField& Md,
const vectorField& fN,
const vectorField& fT,
const vectorField& fP,
const vectorField& d
);
//- Calculate the forces and moments
void calcForcesMoments(const vector& CofR);
//- Return the current centre of the rigid body
virtual vector CofR() const = 0;
//- Write the constant centre of rotation value in the header
// Not written by default
virtual void writeCoRValueHeader(Ostream& file);
//- Write the time varying centre of rotation column header
virtual void writeCoRHeader(Ostream& file);
//- Write the time varying centre of rotation
virtual void writeCofR(Ostream& file);
//- Helper function to write force data
void writeForces();
//- Helper function to write bin data
void writeBins();
public:
//- Runtime type information
TypeName("forcesBase");
// Constructors
//- Construct from Time and dictionary
forcesBase
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Construct from objectRegistry and dictionary
forcesBase
(
const word& name,
const objectRegistry& obr,
const dictionary&
);
//- Disallow default bitwise copy construction
forcesBase(const forcesBase&) = delete;
//- Destructor
virtual ~forcesBase();
// Member Functions
//- Read the forces data
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const
{
return wordList::null();
}
//- Return the effective surface stress
tmp<surfaceVectorField> devTau() const;
//- Dynamic viscosity field
tmp<volScalarField> mu() const;
//- Return rho if specified otherwise rhoRef
tmp<volScalarField> rho() const;
//- Calculate the forces and moments
virtual void calcForcesMoments();
//- Return the total force
virtual vector forceEff() const;
//- Return the total moment
virtual vector momentEff() const;
//- Execute, currently does nothing
virtual bool execute();
//- Write the forces
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const forcesBase&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|