src/OpenFOAM/fields/UniformDimensionedFields/UniformDimensionedField.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::UniformDimensionedField
  26
  27 Description
  28     Dimensioned<Type> registered with the database as a registered IOobject
  29     which has the functionality of a uniform field and allows values from the
  30     top-level code to be passed to boundary conditions etc.
  31
  32 SourceFiles
  33     UniformDimensionedField.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef UniformDimensionedField_H
  38 #define UniformDimensionedField_H
  39
  40 #include "regIOobject.H"
  41 #include "dimensionedType.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                      Class UniformDimensionedField Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 template<class Type>
  53 class UniformDimensionedField
  54 :
  55     public regIOobject,
  56     public dimensioned<Type>
  57 {
  58
  59 public:
  60
  61     //- Runtime type information
  62     TypeName("UniformDimensionedField");
  63
  64
  65     // Constructors
  66
  67         //- Construct from components
  68         UniformDimensionedField(const IOobject&, const dimensioned<Type>&);
  69
  70         //- Construct as copy
  71         UniformDimensionedField(const UniformDimensionedField<Type>&);
  72
  73         //- Construct from Istream
  74         UniformDimensionedField(const IOobject&);
  75
  76
  77     //- Destructor
  78     virtual ~UniformDimensionedField();
  79
  80
  81     // Member Functions
  82
  83         //- Name function provided to resolve the ambiguity between the
  84         //  name functions in regIOobject and dimensioned<Type>
  85         virtual const word& name() const
  86         {
  87             return dimensioned<Type>::name();
  88         }
  89
  90         bool writeData(Ostream&) const;
  91
  92
  93     // Member Operators
  94
  95         void operator=(const UniformDimensionedField<Type>&);
  96         void operator=(const dimensioned<Type>&);
  97 };
  98
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #ifdef NoRepository
 107 #   include "UniformDimensionedField.C"
 108 #endif
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #endif
 113
 114 // ************************************************************************* //