bc5a55f7e6
- compiles - deepClone (not needed at the moment) - objectRegistry::subRegistry with fileName - Time::null object so IOobject can be constructed without objectRegistry
164 lines
4.8 KiB
C++
164 lines
4.8 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | www.openfoam.com
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
Copyright (C) 2011-2017 OpenFOAM Foundation
|
|
Copyright (C) 2021 OpenCFD Ltd.
|
|
-------------------------------------------------------------------------------
|
|
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.
|
|
|
|
Is a 'global' field, same on all processors
|
|
|
|
SourceFiles
|
|
UniformDimensionedField.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef UniformDimensionedField_H
|
|
#define UniformDimensionedField_H
|
|
|
|
#include "regIOobject.H"
|
|
#include "dimensionedType.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class UniformDimensionedField Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class Type>
|
|
class UniformDimensionedField
|
|
:
|
|
public regIOobject,
|
|
public dimensioned<Type>
|
|
{
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("UniformDimensionedField");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from components. Either reads or uses supplied value.
|
|
// The name of the dimensioned\<Type\> defines the name of the
|
|
// field.
|
|
UniformDimensionedField
|
|
(
|
|
const IOobject& io,
|
|
const dimensioned<Type>& dt
|
|
);
|
|
|
|
//- Construct as copy
|
|
UniformDimensionedField(const UniformDimensionedField<Type>& rdt);
|
|
|
|
//- Construct from Istream
|
|
UniformDimensionedField(const IOobject& io);
|
|
|
|
//- Return wrapped pointer to a new regIOobject from an IOobject.
|
|
//- Assumes IOobject contains header information and io.db is polyMesh
|
|
static refPtr<regIOobject> New(const IOobject& io)
|
|
{
|
|
return refPtr<regIOobject>(new UniformDimensionedField<Type>(io));
|
|
}
|
|
|
|
//- Return a clone
|
|
virtual refPtr<regIOobject> deepClone() const
|
|
{
|
|
return regIOobject::DeepClone(*this);
|
|
}
|
|
|
|
|
|
//- 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();
|
|
}
|
|
|
|
//- ReadData function required for regIOobject read operation
|
|
virtual bool readData(Istream&);
|
|
|
|
//- WriteData function required for regIOobject write operation
|
|
bool writeData(Ostream&) const;
|
|
|
|
//- Is object global
|
|
virtual bool global() const
|
|
{
|
|
return true;
|
|
}
|
|
|
|
//- Return complete path + object name if the file exists
|
|
// either in the case/processor or case otherwise null
|
|
virtual fileName filePath() const
|
|
{
|
|
return globalFilePath(type());
|
|
}
|
|
|
|
|
|
// Member Operators
|
|
|
|
//- Assign name, dimensions and value.
|
|
void operator=(const UniformDimensionedField<Type>& rhs);
|
|
|
|
//- Assign name, dimensions and value.
|
|
void operator=(const dimensioned<Type>& rhs);
|
|
|
|
Type operator[](const label) const
|
|
{
|
|
return this->value();
|
|
}
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#ifdef NoRepository
|
|
#include "UniformDimensionedField.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|