File size: 6,008 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::UniformDimensionedField
Description
Dimensioned<Type> registered with the database as a registered IOobject
which has the functionality of a uniform field and allows values from the
top-level code to be passed to boundary conditions etc.
SourceFiles
UniformDimensionedField.C
\*---------------------------------------------------------------------------*/
#ifndef UniformDimensionedField_H
#define UniformDimensionedField_H
#include "regIOobject.H"
#include "dimensionedType.H"
#include "UniformField.H"
#include "OldTimeField.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
template<class Type>
class UniformDimensionedField;
template<class Type>
struct OldTimeField0Type<UniformDimensionedField<Type>>
{
typedef UniformDimensionedField<Type> type;
};
template<class Type>
struct OldTimeOtherFieldType<UniformDimensionedField<Type>>
{
template<template<class> class OtherPrimitiveField>
using type = UniformDimensionedField<Type>;
};
/*---------------------------------------------------------------------------*\
Class UniformDimensionedField Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class UniformDimensionedField
:
public regIOobject,
public dimensioned<Type>,
public tmp<UniformDimensionedField<Type>>::refCount,
public OldTimeField<UniformDimensionedField<Type>>
{
protected:
// Protected Member Functions
//- Construct from IOobject and dimensions without reading
UniformDimensionedField
(
const IOobject&,
const dimensionSet& dims,
const bool
);
//- Construct from IOobject and default value without reading
UniformDimensionedField
(
const IOobject&,
const dimensioned<Type>&,
const bool
);
//- Read the field and check the dimensions
void read
(
const IOobject::readOption& ro,
const dimensionSet& dims
);
public:
// Public Typedefs
//- Type of the non-dimensioned field
typedef UniformField<Type> FieldType;
//- Component type of the elements of the field
typedef typename UniformField<Type>::cmptType cmptType;
//- Runtime type information
TypeName("UniformDimensionedField");
// Constructors
//- Construct from IOobject
UniformDimensionedField(const IOobject&);
//- Construct from IOobject and dimensions
UniformDimensionedField(const IOobject&, const dimensionSet& dims);
//- Construct from IOobject and default value
// reading from the IOobject file according to read option
UniformDimensionedField(const IOobject&, const dimensioned<Type>&);
//- Copy constructor
UniformDimensionedField(const UniformDimensionedField<Type>&);
//- Destructor
virtual ~UniformDimensionedField();
// Member Functions
//- Name function provided to resolve the ambiguity between the
// name functions in regIOobject and dimensioned<Type>
virtual const word& name() const
{
return dimensioned<Type>::name();
}
//- Is object global
virtual bool global() const
{
return true;
}
//- Return a reference to the value after storing old-time values
Type& value();
//- Return a const-reference to the value
const Type& value() const
{
return dimensioned<Type>::value();
}
//- Reset the field values to the given field
// Equivalent to operator=
void reset(const UniformDimensionedField<Type>&);
//- Prevent warning due to read method
using regIOobject::read;
//- WriteData function required for regIOobject write operation
bool writeData(Ostream&) const;
// Member Operators
//- Assign to another field
void operator==(const UniformDimensionedField<Type>&);
//- Assign to another field
void operator=(const UniformDimensionedField<Type>&);
//- Assign to a dimensioned type
void operator=(const dimensioned<Type>&);
//- Access by index
const Type& operator[](const label) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "UniformDimensionedFieldExpression.H"
#ifdef NoRepository
#include "UniformDimensionedField.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|