src/vofDynamicMesh/lnInclude/rasVofForceAndTorqueFunctionObject.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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     rasVofForceAndTorqueFunctionObject
  27
  28 Description
  29     FunctionObject calculating force and torque on walls in turbulent
  30     VOF free surface flows.
  31
  32 Author
  33     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  34
  35 SourceFiles
  36     rasVofForceAndTorqueFunctionObject.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef rasVofForceAndTorqueFunctionObject_H
  41 #define rasVofForceAndTorqueFunctionObject_H
  42
  43 #include "functionObject.H"
  44 #include "dictionary.H"
  45 #include "fvMesh.H"
  46 #include "OFstream.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 /*---------------------------------------------------------------------------*\
  54             Class rasVofForceAndTorqueFunctionObject Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class rasVofForceAndTorqueFunctionObject
  58 :
  59     public functionObject
  60 {
  61     // Private data
  62
  63         //- Name
  64         const word name_;
  65
  66         //- Reference to main object registry
  67         const Time& time_;
  68
  69         //- Region name
  70         word regionName_;
  71
  72         //- List of patches
  73         wordList patchNames_;
  74
  75         //- Origin
  76         point origin_;
  77
  78         //- Output file
  79         OFstream of_;
  80
  81
  82     // Private Member Functions
  83
  84         //- Disallow default bitwise copy construct
  85         rasVofForceAndTorqueFunctionObject
  86         (
  87             const rasVofForceAndTorqueFunctionObject&
  88         );
  89
  90         //- Disallow default bitwise assignment
  91         void operator=(const rasVofForceAndTorqueFunctionObject&);
  92
  93         //- Return the effective viscous stress (laminar + turbulent).
  94         tmp<volSymmTensorField> devRhoReff() const;
  95
  96 public:
  97
  98     //- Runtime type information
  99     TypeName("rasVofForceAndTorque");
 100
 101
 102     // Constructors
 103
 104         //- Construct from components
 105         rasVofForceAndTorqueFunctionObject
 106         (
 107             const word& name,
 108             const Time&,
 109             const dictionary&
 110         );
 111
 112
 113     // Member Functions
 114
 115         //- start is called at the start of the time-loop
 116         virtual bool start();
 117
 118         //- execute is called at each ++ or += of the time-loop
 119         virtual bool execute();
 120
 121         //- Read and set the function object if its data has changed
 122         virtual bool read(const dictionary& dict);
 123 };
 124
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 } // End namespace Foam
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #endif
 133
 134 // ************************************************************************* //