src/finiteVolume/cfdTools/general/fieldSources/basicSource/explicitSource/explicitSource.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::explicitSource
  26
  27 Description
  28     Explicit source.
  29
  30     Sources described by:
  31
  32     explicitSourceCoeffs
  33     {
  34         points            // list of points when selectionMode = points
  35         (
  36             (-0.088 0.007 -0.02)
  37             (-0.028 0.007 -0.02)
  38         );
  39         volumeMode          specific;  //absolute
  40         fieldData            // field data - usage for multiple fields
  41         {
  42             k   30.7;
  43             epsilon  1.5;
  44         }
  45     }
  46
  47 SourceFiles
  48     explicitSource.C
  49
  50 \*---------------------------------------------------------------------------*/
  51
  52 #ifndef explicitSource_H
  53 #define explicitSource_H
  54
  55 #include "cellSet.H"
  56 #include "volFieldsFwd.H"
  57 #include "DimensionedField.H"
  58 #include "basicSource.H"
  59
  60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  61
  62 namespace Foam
  63 {
  64
  65 /*---------------------------------------------------------------------------*\
  66                        Class explicitSource Declaration
  67 \*---------------------------------------------------------------------------*/
  68
  69 class explicitSource
  70 :
  71     public basicSource
  72 {
  73     // Private data
  74
  75         //- List of field types
  76         HashTable<scalar> scalarFields_;
  77         HashTable<vector> vectorFields_;
  78
  79         //- Add source to matrix
  80         template<class Type>
  81         void addSource(fvMatrix<Type>&, const Type&) const;
  82
  83         //- Add field names and values to field table for types.
  84         template<class Type>
  85         void addField
  86         (
  87             HashTable<Type>& fields,
  88             const wordList& fieldTypes,
  89             const wordList& fieldNames,
  90             const dictionary& dict
  91         );
  92
  93
  94 public:
  95
  96     // Public data
  97
  98         //- Enumeration for volume types
  99         enum volumeModeType
 100         {
 101             vmAbsolute,
 102             vmSpecific
 103         };
 104
 105         //- Word list of volume mode type names
 106         static const NamedEnum<volumeModeType, 2> volumeModeTypeNames_;
 107
 108
 109 protected:
 110
 111     // Protected data
 112
 113          //- Sub dictionary for time activated explicit sources
 114         const dictionary& dict_;
 115
 116         //- Volume mode
 117         volumeModeType volumeMode_;
 118
 119
 120     // Protected functions
 121
 122         //- Set the local field data
 123         void setFieldData(const dictionary& dict);
 124
 125
 126 public:
 127
 128     //- Runtime type information
 129     TypeName("explicitSource");
 130
 131
 132     // Constructors
 133
 134         //- Construct from components
 135         explicitSource
 136         (
 137             const word& name,
 138             const word& modelType,
 139             const dictionary& dict,
 140             const fvMesh& mesh
 141         );
 142
 143         //- Return clone
 144         autoPtr<explicitSource> clone() const
 145         {
 146             notImplemented
 147             (
 148                 "autoPtr<explicitSource> clone() const"
 149             );
 150             return autoPtr<explicitSource>(NULL);
 151         }
 152
 153
 154
 155     // Member Functions
 156
 157         // Access
 158
 159             //- Return const access to the volume mode
 160             inline const volumeModeType& volumeMode() const;
 161
 162
 163         // Edit
 164
 165             //- Return access to the volume mode
 166             inline volumeModeType& volumeMode();
 167
 168             //- Return points
 169             inline  const List<point>& points() const;
 170
 171
 172         // Evaluation
 173
 174             //-Source term to fvMatrix<vector>
 175             virtual void addSu(fvMatrix<vector>& UEqn);
 176
 177             //-Source term to fvMatrix<scalar>
 178             virtual void addSu(fvMatrix<scalar>& UEqn);
 179
 180
 181         // I-O
 182
 183             //- Write the source properties
 184             virtual void writeData(Ostream&) const;
 185
 186             //- Read fieldData in sub-dictionary
 187             virtual bool read(const dictionary& dict);
 188
 189             //- Ostream operator
 190             friend Ostream& operator<<
 191             (
 192                 Ostream& os,
 193                 const explicitSource& source
 194             );
 195 };
 196
 197
 198 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 199
 200 } // End namespace Foam
 201
 202 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 203
 204 #include "explicitSourceIO.C"
 205 #include "explicitSourceI.H"
 206
 207 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 208
 209 #ifdef NoRepository
 210 #   include "explicitSourceTemplates.C"
 211 #endif
 212
 213 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 214
 215 #endif
 216
 217 // ************************************************************************* //