src/finiteArea/fields/faPatchFields/derived/inletOutlet/inletOutletFaPatchField.C

   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 \*---------------------------------------------------------------------------*/
  26
  27 #include "inletOutletFaPatchField.H"
  28
  29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  30
  31 namespace Foam
  32 {
  33
  34 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  35
  36 template<class Type>
  37 inletOutletFaPatchField<Type>::inletOutletFaPatchField
  38 (
  39     const faPatch& p,
  40     const DimensionedField<Type, areaMesh>& iF
  41 )
  42 :
  43     mixedFaPatchField<Type>(p, iF),
  44     phiName_("phi")
  45 {
  46     this->refValue() = pTraits<Type>::zero;
  47     this->refGrad() = pTraits<Type>::zero;
  48     this->valueFraction() = 0.0;
  49 }
  50
  51
  52 template<class Type>
  53 inletOutletFaPatchField<Type>::inletOutletFaPatchField
  54 (
  55     const inletOutletFaPatchField<Type>& ptf,
  56     const faPatch& p,
  57     const DimensionedField<Type, areaMesh>& iF,
  58     const faPatchFieldMapper& mapper
  59 )
  60 :
  61     mixedFaPatchField<Type>(ptf, p, iF, mapper),
  62     phiName_(ptf.phiName_)
  63 {}
  64
  65
  66 template<class Type>
  67 inletOutletFaPatchField<Type>::inletOutletFaPatchField
  68 (
  69     const faPatch& p,
  70     const DimensionedField<Type, areaMesh>& iF,
  71     const dictionary& dict
  72 )
  73 :
  74     mixedFaPatchField<Type>(p, iF),
  75     phiName_("phi")
  76 {
  77     this->refValue() = Field<Type>("inletValue", dict, p.size());
  78
  79     if (dict.found("value"))
  80     {
  81         faPatchField<Type>::operator=
  82         (
  83             Field<Type>("value", dict, p.size())
  84         );
  85     }
  86     else
  87     {
  88         faPatchField<Type>::operator=(this->refValue());
  89     }
  90
  91     this->refGrad() = pTraits<Type>::zero;
  92     this->valueFraction() = 0.0;
  93
  94     if (dict.found("phi"))
  95     {
  96         dict.lookup("phi") >> phiName_;
  97     }
  98 }
  99
 100
 101 template<class Type>
 102 inletOutletFaPatchField<Type>::inletOutletFaPatchField
 103 (
 104     const inletOutletFaPatchField<Type>& ptf
 105 )
 106 :
 107     mixedFaPatchField<Type>(ptf),
 108     phiName_(ptf.phiName_)
 109 {}
 110
 111
 112 template<class Type>
 113 inletOutletFaPatchField<Type>::inletOutletFaPatchField
 114 (
 115     const inletOutletFaPatchField<Type>& ptf,
 116     const DimensionedField<Type, areaMesh>& iF
 117 )
 118 :
 119     mixedFaPatchField<Type>(ptf, iF),
 120     phiName_(ptf.phiName_)
 121 {}
 122
 123
 124 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 125
 126 template<class Type>
 127 void inletOutletFaPatchField<Type>::updateCoeffs()
 128 {
 129     if (this->updated())
 130     {
 131         return;
 132     }
 133
 134     const Field<scalar>& phip = this->patch().lookupPatchField
 135     (
 136         phiName_,
 137         reinterpret_cast<const edgeScalarField*>(NULL),
 138         reinterpret_cast<const scalar*>(NULL)
 139     );
 140
 141     this->valueFraction() = 1.0 - pos(phip);
 142
 143     mixedFaPatchField<Type>::updateCoeffs();
 144 }
 145
 146
 147 template<class Type>
 148 void inletOutletFaPatchField<Type>::write(Ostream& os) const
 149 {
 150     faPatchField<Type>::write(os);
 151     if (phiName_ != "phi")
 152     {
 153         os.writeKeyword("phi")
 154             << phiName_ << token::END_STATEMENT << nl;
 155     }
 156     this->refValue().writeEntry("inletValue", os);
 157     this->writeEntry("value", os);
 158 }
 159
 160
 161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 162
 163 } // End namespace Foam
 164
 165 // ************************************************************************* //