src/lagrangian/intermediate/submodels/SubModelBase.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 "SubModelBase.H"
  27
  28 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  29
  30 template<class CloudType>
  31 Foam::SubModelBase<CloudType>::SubModelBase(CloudType& owner)
  32 :
  33     owner_(owner),
  34     dict_(dictionary::null),
  35     coeffDict_(dictionary::null)
  36 {}
  37
  38
  39 template<class CloudType>
  40 Foam::SubModelBase<CloudType>::SubModelBase
  41 (
  42     CloudType& owner,
  43     const dictionary& dict,
  44     const word& name,
  45     const word& dictExt
  46 )
  47 :
  48     owner_(owner),
  49     dict_(dict),
  50     coeffDict_(dict.subDict(name + dictExt))
  51 {}
  52
  53
  54 template<class CloudType>
  55 Foam::SubModelBase<CloudType>::SubModelBase(const SubModelBase<CloudType>& smb)
  56 :
  57     owner_(smb.owner_),
  58     dict_(smb.dict_),
  59     coeffDict_(smb.coeffDict_)
  60 {}
  61
  62
  63 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  64
  65 template<class CloudType>
  66 Foam::SubModelBase<CloudType>::~SubModelBase()
  67 {}
  68
  69
  70 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  71
  72 template<class CloudType>
  73 const CloudType& Foam::SubModelBase<CloudType>::owner() const
  74 {
  75     return owner_;
  76 }
  77
  78
  79 template<class CloudType>
  80 const Foam::dictionary& Foam::SubModelBase<CloudType>::dict() const
  81 {
  82     return dict_;
  83 }
  84
  85
  86 template<class CloudType>
  87 const Foam::dictionary& Foam::SubModelBase<CloudType>::coeffDict() const
  88 {
  89     return coeffDict_;
  90 }
  91
  92
  93 template<class CloudType>
  94 bool Foam::SubModelBase<CloudType>::defaultCoeffs(const bool printMsg) const
  95 {
  96     bool def = coeffDict_.lookupOrDefault<bool>("defaultCoeffs", false);
  97     if (printMsg && def)
  98     {
  99         Info<< incrIndent;
 100         Info<< indent << "Employing default coefficients" << endl;
 101         Info<< decrIndent;
 102     }
 103
 104     return def;
 105 }
 106
 107
 108 template<class CloudType>
 109 CloudType& Foam::SubModelBase<CloudType>::owner()
 110 {
 111     return owner_;
 112 }
 113
 114
 115 template<class CloudType>
 116 bool Foam::SubModelBase<CloudType>::active() const
 117 {
 118     return true;
 119 }
 120
 121
 122 template<class CloudType>
 123 void Foam::SubModelBase<CloudType>::cacheFields(const bool)
 124 {
 125     // do nothing
 126 }
 127
 128
 129 template<class CloudType>
 130 void Foam::SubModelBase<CloudType>::write(Ostream& os) const
 131 {
 132     os.writeKeyword("owner") << owner_.name() << token::END_STATEMENT << nl;
 133
 134     // not writing complete cloud dictionary, only coeffs
 135 //    os  << dict_;
 136     os  << coeffDict_;
 137 }
 138
 139
 140 // ************************************************************************* //