src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::forceCoeffs
  26
  27 Description
  28     Derived from the forces function object, creates a specialisation to
  29     calculate lift and drag forces.
  30
  31 SourceFiles
  32     forceCoeffs.C
  33     IOforceCoeffs.H
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef forceCoeffs_H
  38 #define forceCoeffs_H
  39
  40 #include "forces.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                         Class forceCoeffs Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class forceCoeffs
  52 :
  53     public forces
  54 {
  55     // Private data
  56
  57         // Force coefficient geometry
  58
  59             //- Lift
  60             vector liftDir_;
  61
  62             //- Drag
  63             vector  dragDir_;
  64
  65             //- Pitch
  66             vector pitchAxis_;
  67
  68
  69         // Free-stream conditions
  70
  71             //- Velocity magnitude
  72             scalar magUInf_;
  73
  74
  75         // Reference scales
  76
  77             //- Length
  78             scalar lRef_;
  79
  80             //- Area
  81             scalar Aref_;
  82
  83
  84     // Private Member Functions
  85
  86         //- Disallow default bitwise copy construct
  87         forceCoeffs(const forceCoeffs&);
  88
  89         //- Disallow default bitwise assignment
  90         void operator=(const forceCoeffs&);
  91
  92
  93 protected:
  94
  95     //- Output file header information
  96     virtual void writeFileHeader();
  97
  98
  99 public:
 100
 101     //- Runtime type information
 102     TypeName("forceCoeffs");
 103
 104
 105     // Constructors
 106
 107         //- Construct for given objectRegistry and dictionary.
 108         //  Allow the possibility to load fields from files
 109         forceCoeffs
 110         (
 111             const word& name,
 112             const objectRegistry&,
 113             const dictionary&,
 114             const bool loadFromFiles = false
 115         );
 116
 117
 118     //- Destructor
 119     virtual ~forceCoeffs();
 120
 121
 122     // Member Functions
 123
 124         //- Read the forces data
 125         virtual void read(const dictionary&);
 126
 127         //- Execute, currently does nothing
 128         virtual void execute();
 129
 130         //- Execute at the final time-loop, currently does nothing
 131         virtual void end();
 132
 133         //- Write the forces
 134         virtual void write();
 135 };
 136
 137
 138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 139
 140 } // End namespace Foam
 141
 142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 143
 144 #endif
 145
 146 // ************************************************************************* //