mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
352 lines
9.7 KiB
C++
352 lines
9.7 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2013 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::forces
|
|
|
|
Group
|
|
grpForcesFunctionObjects
|
|
|
|
Description
|
|
This function object calculates the forces and moments by integrating the
|
|
pressure and skin-friction forces over a given list of patches.
|
|
|
|
Member function forces::write() calculates the forces/moments and
|
|
writes the forces/moments into the file \<timeDir\>/forces.dat
|
|
|
|
Example of function object specification:
|
|
\verbatim
|
|
forces1
|
|
{
|
|
type forces;
|
|
functionObjectLibs ("libforces.so");
|
|
...
|
|
log yes;
|
|
patches (walls);
|
|
nBin 20;
|
|
binDir (1 0 0);
|
|
binFormat gnuplot;
|
|
}
|
|
\endverbatim
|
|
|
|
\heading Function object usage
|
|
\table
|
|
Property | Description | Required | Default value
|
|
type | type name: forces | yes |
|
|
log | write force data to standard output | no | no
|
|
patches | patches included in the forces calculation | yes |
|
|
nBin | number of data bins | no |
|
|
binDir | direction along which bins are defined | no |
|
|
binFormat | output format for bin data | no |
|
|
pName | pressure field name | no | p
|
|
UName | velocity field name | no | U
|
|
rhoName | density field name (see below) | no | rho
|
|
CofR | centre of rotation (see below) | no |
|
|
directForceDensity | force density supplied directly (see below)|no|no
|
|
fDName | name of force density field (see below) | no | fD
|
|
\endtable
|
|
|
|
Note
|
|
- For incompressible cases, set \c rhoName to \c rhoInf. You will then be
|
|
required to provide a \c rhoInf value corresponding to the free-stream
|
|
constant density.
|
|
- If the force density is supplied directly, set the \c directForceDensity
|
|
flag to 'yes', and supply the force density field using the \c
|
|
fDName entry
|
|
- The centre of rotation (CofR) for moment calculations can either be
|
|
specified by an \c CofR entry, or be taken from origin of the local
|
|
coordinate system. For example,
|
|
\verbatim
|
|
CofR (0 0 0);
|
|
\endverbatim
|
|
or
|
|
\verbatim
|
|
coordinateSystem
|
|
{
|
|
origin (0 0 0);
|
|
e3 (0 0 1);
|
|
e1 (1 0 0);
|
|
}
|
|
\endverbatim
|
|
|
|
SeeAlso
|
|
Foam::functionObject
|
|
Foam::OutputFilterFunctionObject
|
|
Foam::forceCoeffs
|
|
|
|
SourceFiles
|
|
forces.C
|
|
IOforces.H
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef forces_H
|
|
#define forces_H
|
|
|
|
#include "functionObjectFile.H"
|
|
#include "coordinateSystem.H"
|
|
#include "coordinateSystems.H"
|
|
#include "primitiveFieldsFwd.H"
|
|
#include "volFieldsFwd.H"
|
|
#include "HashSet.H"
|
|
#include "Tuple2.H"
|
|
#include "OFstream.H"
|
|
#include "Switch.H"
|
|
#include "writer.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// Forward declaration of classes
|
|
class objectRegistry;
|
|
class dictionary;
|
|
class polyMesh;
|
|
class mapPolyMesh;
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class forces Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class forces
|
|
:
|
|
public functionObjectFile
|
|
{
|
|
protected:
|
|
|
|
// Protected data
|
|
|
|
//- Name of this set of forces,
|
|
// Also used as the name of the probes directory.
|
|
word name_;
|
|
|
|
const objectRegistry& obr_;
|
|
|
|
//- On/off switch
|
|
bool active_;
|
|
|
|
//- Switch to send output to Info as well as to file
|
|
Switch log_;
|
|
|
|
//- 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_;
|
|
|
|
//- 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_;
|
|
|
|
//- Coordinate system used when evaluting forces/moments
|
|
coordinateSystem coordSys_;
|
|
|
|
//- Flag to indicate whether we are using a local co-ordinate sys
|
|
bool localSystem_;
|
|
|
|
//- 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_;
|
|
|
|
//- Write format for bin data
|
|
word binFormat_;
|
|
|
|
//- Should bin data be cumulative?
|
|
bool binCumulative_;
|
|
|
|
|
|
// Protected Member Functions
|
|
|
|
//- Create file names for forces and bins
|
|
wordList createFileNames(const dictionary& dict) const;
|
|
|
|
//- Output file header information
|
|
virtual void writeFileHeader(const label i);
|
|
|
|
//- Return the effective viscous stress (laminar + turbulent).
|
|
tmp<volSymmTensorField> devRhoReff() const;
|
|
|
|
//- Dynamic viscosity field
|
|
tmp<volScalarField> mu() const;
|
|
|
|
//- Return rho if rhoName is specified otherwise rhoRef
|
|
tmp<volScalarField> rho() const;
|
|
|
|
//- Return rhoRef if the pressure field is dynamic, i.e. p/rho
|
|
// otherwise return 1
|
|
scalar rho(const volScalarField& p) const;
|
|
|
|
//- Accumulate bin data
|
|
void applyBins
|
|
(
|
|
const vectorField& Md,
|
|
const vectorField& fN,
|
|
const vectorField& fT,
|
|
const vectorField& fP,
|
|
const vectorField& d
|
|
);
|
|
|
|
//- Helper function to write force data
|
|
void writeForces();
|
|
|
|
//- Helper function to write bin data
|
|
void writeBins();
|
|
|
|
//- Disallow default bitwise copy construct
|
|
forces(const forces&);
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const forces&);
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("forces");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct for given objectRegistry and dictionary.
|
|
// Allow the possibility to load fields from files
|
|
forces
|
|
(
|
|
const word& name,
|
|
const objectRegistry&,
|
|
const dictionary&,
|
|
const bool loadFromFiles = false
|
|
);
|
|
|
|
|
|
//- Construct from components
|
|
forces
|
|
(
|
|
const word& name,
|
|
const objectRegistry&,
|
|
const labelHashSet& patchSet,
|
|
const word& pName,
|
|
const word& UName,
|
|
const word& rhoName,
|
|
const scalar rhoInf,
|
|
const scalar pRef,
|
|
const coordinateSystem& coordSys
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~forces();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Return name of the set of forces
|
|
virtual const word& name() const
|
|
{
|
|
return name_;
|
|
}
|
|
|
|
//- Read the forces data
|
|
virtual void read(const dictionary&);
|
|
|
|
//- Execute, currently does nothing
|
|
virtual void execute();
|
|
|
|
//- Execute at the final time-loop, currently does nothing
|
|
virtual void end();
|
|
|
|
//- Called when time was set at the end of the Time::operator++
|
|
virtual void timeSet();
|
|
|
|
//- Write the forces
|
|
virtual void write();
|
|
|
|
//- Calculate the forces and moments
|
|
virtual void calcForcesMoment();
|
|
|
|
//- Return the total force
|
|
virtual vector forceEff() const;
|
|
|
|
//- Return the total moment
|
|
virtual vector momentEff() const;
|
|
|
|
//- Update for changes of mesh
|
|
virtual void updateMesh(const mapPolyMesh&)
|
|
{}
|
|
|
|
//- Update for changes of mesh
|
|
virtual void movePoints(const polyMesh&)
|
|
{}
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|