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) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::forceCoeffs
  27
  28 Description
  29     Derived from the forces function object, creates a specialisation to
  30     calculate lift and drag forces.
  31
  32 SourceFiles
  33     forceCoeffs.C
  34     IOforceCoeffs.H
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef forceCoeffs_H
  39 #define forceCoeffs_H
  40
  41 #include "forces.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                         Class forceCoeffs Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class forceCoeffs
  53 :
  54     public forces
  55 {
  56     // Private data
  57
  58         // Force coefficient geometry
  59
  60             //- Lift
  61             vector liftDir_;
  62
  63             //- Drag
  64             vector  dragDir_;
  65
  66             //- Pitch
  67             vector pitchAxis_;
  68
  69
  70         // Free-stream conditions
  71
  72             //- Velocity magnitude
  73             scalar magUInf_;
  74
  75
  76         // Reference scales
  77
  78             //- Length
  79             scalar lRef_;
  80
  81             //- Area
  82             scalar Aref_;
  83
  84
  85     // Private member functions
  86
  87         //- Disallow default bitwise copy construct
  88         forceCoeffs(const forceCoeffs&);
  89
  90         //- Disallow default bitwise assignment
  91         void operator=(const forceCoeffs&);
  92
  93
  94 protected:
  95
  96     //- Output file header information
  97     virtual void writeFileHeader();
  98
  99
 100 public:
 101
 102     //- Runtime type information
 103     TypeName("forceCoeffs");
 104
 105
 106     // Constructors
 107
 108         //- Construct for given objectRegistry and dictionary.
 109         //  Allow the possibility to load fields from files
 110         forceCoeffs
 111         (
 112             const word& name,
 113             const objectRegistry&,
 114             const dictionary&,
 115             const bool loadFromFiles = false
 116         );
 117
 118
 119     // Destructor
 120
 121         virtual ~forceCoeffs();
 122
 123
 124     // Member Functions
 125
 126         //- Read the forces data
 127         virtual void read(const dictionary&);
 128
 129         //- Execute, currently does nothing
 130         virtual void execute();
 131
 132         //- Execute at the final time-loop, currently does nothing
 133         virtual void end();
 134
 135         //- Write the forces
 136         virtual void write();
 137 };
 138
 139
 140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 141
 142 } // End namespace Foam
 143
 144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 145
 146 #endif
 147
 148 // ************************************************************************* //