openfoam/src/finiteArea/fields/faePatchFields/basic/calculated/calculatedFaePatchField.H
Mark Olesen 87eed5e3b8 ENH: place more patch field attributes under template invariant Base
- attributes such as assignable(), coupled() etc

- common patchField types: calculatedType(), zeroGradientType() etc.
  This simplifies reference to these types without actually needing a
  typed patchField version.

ENH: add some basic patchField types to fieldTypes namespace

- allows more general use of the names

ENH: set extrapolated/calculated from patchInternalField directly

- avoids intermediate tmp
2023-04-03 13:33:56 +02:00

157 lines
4.5 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2016-2017 Wikki Ltd
Copyright (C) 2019-2023 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::calculatedFaePatchField
Description
Author
Zeljko Tukovic, FMENA
Hrvoje Jasak, Wikki Ltd.
SourceFiles
calculatedFaePatchField.C
\*---------------------------------------------------------------------------*/
#ifndef Foam_calculatedFaePatchField_H
#define Foam_calculatedFaePatchField_H
#include "faePatchField.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class calculatedFaePatch Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class calculatedFaePatchField
:
public faePatchField<Type>
{
public:
//- Runtime type information
TypeName("calculated"); // fieldTypes::calculatedTypeName_()
// Constructors
//- Construct from patch and internal field
calculatedFaePatchField
(
const faPatch&,
const DimensionedField<Type, edgeMesh>&
);
//- Construct from patch, internal field and dictionary
calculatedFaePatchField
(
const faPatch&,
const DimensionedField<Type, edgeMesh>&,
const dictionary& dict,
//! The "value" entry (default: mandatory)
IOobjectOption::readOption valueRequired = IOobjectOption::MUST_READ
);
//- Construct by mapping given patch field onto a new patch
calculatedFaePatchField
(
const calculatedFaePatchField<Type>&,
const faPatch&,
const DimensionedField<Type, edgeMesh>&,
const faPatchFieldMapper&
);
//- Construct as copy
calculatedFaePatchField(const calculatedFaePatchField<Type>&);
//- Construct and return a clone
virtual tmp<faePatchField<Type>> clone() const
{
return tmp<faePatchField<Type>>
(
new calculatedFaePatchField<Type>(*this)
);
}
//- Construct as copy setting internal field reference
calculatedFaePatchField
(
const calculatedFaePatchField<Type>&,
const DimensionedField<Type, edgeMesh>&
);
//- Construct and return a clone setting internal field reference
virtual tmp<faePatchField<Type>> clone
(
const DimensionedField<Type, edgeMesh>& iF
) const
{
return tmp<faePatchField<Type>>
(
new calculatedFaePatchField<Type>(*this, iF)
);
}
//- Destructor
virtual ~calculatedFaePatchField() = default;
// Member Functions
//- True: the patch field fixes a value.
virtual bool fixesValue() const { return true; }
// Other
//- Write
virtual void write(Ostream&) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "calculatedFaePatchField.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //