etc/codeTemplates/dynamicCode/fixedValueFvPatchFieldTemplate.C

   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 \*---------------------------------------------------------------------------*/
  25
  26 #include "fixedValueFvPatchFieldTemplate.H"
  27 #include "addToRunTimeSelectionTable.H"
  28 #include "fvPatchFieldMapper.H"
  29 #include "volFields.H"
  30 #include "surfaceFields.H"
  31 //{{{ begin codeInclude
  32 ${codeInclude}
  33 //}}} end codeInclude
  34
  35
  36 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  37
  38 namespace Foam
  39 {
  40
  41 // * * * * * * * * * * * * * * * Local Functions * * * * * * * * * * * * * * //
  42
  43 //{{{ begin localCode
  44 ${localCode}
  45 //}}} end localCode
  46
  47
  48 // * * * * * * * * * * * * * * * Global Functions  * * * * * * * * * * * * * //
  49
  50 extern "C"
  51 {
  52     // dynamicCode:
  53     // SHA1 = ${SHA1sum}
  54     //
  55     // unique function name that can be checked if the correct library version
  56     // has been loaded
  57     void ${typeName}_${SHA1sum}(bool load)
  58     {
  59         if (load)
  60         {
  61             // code that can be explicitly executed after loading
  62         }
  63         else
  64         {
  65             // code that can be explicitly executed before unloading
  66         }
  67     }
  68 }
  69
  70 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  71
  72 makeRemovablePatchTypeField
  73 (
  74     fvPatch${FieldType},
  75     ${typeName}FixedValueFvPatch${FieldType}
  76 );
  77
  78
  79 const char* const ${typeName}FixedValueFvPatch${FieldType}::SHA1sum =
  80     "${SHA1sum}";
  81
  82
  83 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  84
  85 ${typeName}FixedValueFvPatch${FieldType}::
  86 ${typeName}FixedValueFvPatch${FieldType}
  87 (
  88     const fvPatch& p,
  89     const DimensionedField<${TemplateType}, volMesh>& iF
  90 )
  91 :
  92     fixedValueFvPatchField<${TemplateType}>(p, iF)
  93 {
  94     if (${verbose:-false})
  95     {
  96         Info<<"construct ${typeName} sha1: ${SHA1sum}"
  97             " from patch/DimensionedField\n";
  98     }
  99 }
 100
 101
 102 ${typeName}FixedValueFvPatch${FieldType}::
 103 ${typeName}FixedValueFvPatch${FieldType}
 104 (
 105     const ${typeName}FixedValueFvPatch${FieldType}& ptf,
 106     const fvPatch& p,
 107     const DimensionedField<${TemplateType}, volMesh>& iF,
 108     const fvPatchFieldMapper& mapper
 109 )
 110 :
 111     fixedValueFvPatchField<${TemplateType}>(ptf, p, iF, mapper)
 112 {
 113     if (${verbose:-false})
 114     {
 115         Info<<"construct ${typeName} sha1: ${SHA1sum}"
 116             " from patch/DimensionedField/mapper\n";
 117     }
 118 }
 119
 120
 121 ${typeName}FixedValueFvPatch${FieldType}::
 122 ${typeName}FixedValueFvPatch${FieldType}
 123 (
 124     const fvPatch& p,
 125     const DimensionedField<${TemplateType}, volMesh>& iF,
 126     const dictionary& dict
 127 )
 128 :
 129     fixedValueFvPatchField<${TemplateType}>(p, iF, dict)
 130 {
 131     if (${verbose:-false})
 132     {
 133         Info<<"construct ${typeName} sha1: ${SHA1sum}"
 134             " from patch/dictionary\n";
 135     }
 136 }
 137
 138
 139 ${typeName}FixedValueFvPatch${FieldType}::
 140 ${typeName}FixedValueFvPatch${FieldType}
 141 (
 142     const ${typeName}FixedValueFvPatch${FieldType}& ptf
 143 )
 144 :
 145     fixedValueFvPatchField<${TemplateType}>(ptf)
 146 {
 147     if (${verbose:-false})
 148     {
 149         Info<<"construct ${typeName} sha1: ${SHA1sum}"
 150             " as copy\n";
 151     }
 152 }
 153
 154
 155 ${typeName}FixedValueFvPatch${FieldType}::
 156 ${typeName}FixedValueFvPatch${FieldType}
 157 (
 158     const ${typeName}FixedValueFvPatch${FieldType}& ptf,
 159     const DimensionedField<${TemplateType}, volMesh>& iF
 160 )
 161 :
 162     fixedValueFvPatchField<${TemplateType}>(ptf, iF)
 163 {
 164     if (${verbose:-false})
 165     {
 166         Info<<"construct ${typeName} sha1: ${SHA1sum} "
 167             "as copy/DimensionedField\n";
 168     }
 169 }
 170
 171
 172 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 173
 174 ${typeName}FixedValueFvPatch${FieldType}::
 175 ~${typeName}FixedValueFvPatch${FieldType}()
 176 {
 177     if (${verbose:-false})
 178     {
 179         Info<<"destroy ${typeName} sha1: ${SHA1sum}\n";
 180     }
 181 }
 182
 183
 184 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 185
 186 void ${typeName}FixedValueFvPatch${FieldType}::updateCoeffs()
 187 {
 188     if (this->updated())
 189     {
 190         return;
 191     }
 192
 193     if (${verbose:-false})
 194     {
 195         Info<<"updateCoeffs ${typeName} sha1: ${SHA1sum}\n";
 196     }
 197
 198 //{{{ begin code
 199     ${code}
 200 //}}} end code
 201
 202     this->fixedValueFvPatchField<${TemplateType}>::updateCoeffs();
 203 }
 204
 205
 206 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 207
 208 } // End namespace Foam
 209
 210 // ************************************************************************* //