mirror of
https://github.com/OpenFOAM/OpenFOAM-6.git
synced 2025-12-08 06:57:46 +00:00
fe43b80536
These new names are more consistent and logical because:
primitiveField():
primitiveFieldRef():
Provides low-level access to the Field<Type> (primitive field)
without dimension or mesh-consistency checking. This should only be
used in the low-level functions where dimensional consistency is
ensured by careful programming and computational efficiency is
paramount.
internalField():
internalFieldRef():
Provides access to the DimensionedField<Type, GeoMesh> of values on
the internal mesh-type for which the GeometricField is defined and
supports dimension and checking and mesh-consistency checking.
661 lines
19 KiB
C++
661 lines
19 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2016 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::GeometricField
|
|
|
|
Description
|
|
Generic GeometricField class.
|
|
|
|
SourceFiles
|
|
GeometricFieldI.H
|
|
GeometricField.C
|
|
Boundary.C
|
|
GeometricFieldFunctions.H
|
|
GeometricFieldFunctions.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef GeometricField_H
|
|
#define GeometricField_H
|
|
|
|
#include "regIOobject.H"
|
|
#include "dimensionedTypes.H"
|
|
#include "DimensionedField.H"
|
|
#include "FieldField.H"
|
|
#include "lduInterfaceFieldPtrsList.H"
|
|
#include "LduInterfaceFieldPtrsList.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
class dictionary;
|
|
|
|
// Forward declaration of friend functions and operators
|
|
|
|
template<class Type, template<class> class PatchField, class GeoMesh>
|
|
class GeometricField;
|
|
|
|
template<class Type, template<class> class PatchField, class GeoMesh>
|
|
Ostream& operator<<
|
|
(
|
|
Ostream&,
|
|
const GeometricField<Type, PatchField, GeoMesh>&
|
|
);
|
|
|
|
template<class Type, template<class> class PatchField, class GeoMesh>
|
|
Ostream& operator<<
|
|
(
|
|
Ostream&,
|
|
const tmp<GeometricField<Type, PatchField, GeoMesh>>&
|
|
);
|
|
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class GeometricField Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class Type, template<class> class PatchField, class GeoMesh>
|
|
class GeometricField
|
|
:
|
|
public DimensionedField<Type, GeoMesh>
|
|
{
|
|
// Private Member Functions
|
|
|
|
//- Read from file if it is present
|
|
bool readIfPresent();
|
|
|
|
//- Read old time field from file if it is present
|
|
bool readOldTimeIfPresent();
|
|
|
|
|
|
public:
|
|
|
|
// Public typedefs
|
|
|
|
//- Type of mesh on which this GeometricField is instantiated
|
|
typedef typename GeoMesh::Mesh Mesh;
|
|
|
|
//- Type of boundary mesh on which this
|
|
// GeometricField::Boundary is instantiated
|
|
typedef typename GeoMesh::BoundaryMesh BoundaryMesh;
|
|
|
|
//- Type of the internal field from which this GeometricField is derived
|
|
typedef DimensionedField<Type, GeoMesh> Internal;
|
|
|
|
//- Type of the patch field of which the
|
|
// GeometricField::Boundary is composed
|
|
typedef PatchField<Type> Patch;
|
|
|
|
|
|
class Boundary
|
|
:
|
|
public FieldField<PatchField, Type>
|
|
{
|
|
// Private data
|
|
|
|
//- Reference to BoundaryMesh for which this field is defined
|
|
const BoundaryMesh& bmesh_;
|
|
|
|
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
//- Construct from a BoundaryMesh
|
|
Boundary(const BoundaryMesh&);
|
|
|
|
//- Construct from a BoundaryMesh,
|
|
// reference to the internal field
|
|
// and a patch type
|
|
Boundary
|
|
(
|
|
const BoundaryMesh&,
|
|
const Internal&,
|
|
const word&
|
|
);
|
|
|
|
//- Construct from a BoundaryMesh,
|
|
// reference to the internal field
|
|
// and a wordList of patch types and optional the actual patch
|
|
// types (to override constraint patches)
|
|
Boundary
|
|
(
|
|
const BoundaryMesh&,
|
|
const Internal&,
|
|
const wordList& wantedPatchTypes,
|
|
const wordList& actualPatchTypes = wordList()
|
|
);
|
|
|
|
//- Construct from a BoundaryMesh,
|
|
// reference to the internal field
|
|
// and a PtrList<PatchField<Type>>
|
|
Boundary
|
|
(
|
|
const BoundaryMesh&,
|
|
const Internal&,
|
|
const PtrList<PatchField<Type>>&
|
|
);
|
|
|
|
//- Construct as copy setting the reference to the internal field
|
|
Boundary
|
|
(
|
|
const Internal&,
|
|
const Boundary&
|
|
);
|
|
|
|
//- Construct as copy
|
|
// Dangerous because Field may be set to a field which gets deleted
|
|
// Need new type of BoundaryField, one which is part of a geometric
|
|
// field for which snGrad etc. may be called and a free standing
|
|
// BoundaryField for which such operations are unavailable.
|
|
Boundary
|
|
(
|
|
const Boundary&
|
|
);
|
|
|
|
//- Construct from dictionary
|
|
Boundary
|
|
(
|
|
const BoundaryMesh&,
|
|
const Internal&,
|
|
const dictionary&
|
|
);
|
|
|
|
|
|
// Member functions
|
|
|
|
//- Read the boundary field
|
|
void readField
|
|
(
|
|
const Internal& field,
|
|
const dictionary& dict
|
|
);
|
|
|
|
//- Update the boundary condition coefficients
|
|
void updateCoeffs();
|
|
|
|
//- Evaluate boundary conditions
|
|
void evaluate();
|
|
|
|
//- Return a list of the patch types
|
|
wordList types() const;
|
|
|
|
//- Return BoundaryField of the cell values neighbouring
|
|
// the boundary
|
|
Boundary boundaryInternalField() const;
|
|
|
|
//- Return a list of pointers for each patch field with only those
|
|
// pointing to interfaces being set
|
|
LduInterfaceFieldPtrsList<Type> interfaces() const;
|
|
|
|
//- Return a list of pointers for each patch field with only those
|
|
// pointing to interfaces being set
|
|
lduInterfaceFieldPtrsList scalarInterfaces() const;
|
|
|
|
//- Write boundary field as dictionary entry
|
|
void writeEntry(const word& keyword, Ostream& os) const;
|
|
|
|
|
|
// Member operators
|
|
|
|
//- Assignment to BoundaryField<Type, PatchField, BoundaryMesh>
|
|
void operator=(const Boundary&);
|
|
|
|
//- Assignment to FieldField<PatchField, Type>
|
|
void operator=(const FieldField<PatchField, Type>&);
|
|
|
|
//- Assignment to Type
|
|
void operator=(const Type&);
|
|
|
|
|
|
//- Forced assignment to
|
|
// BoundaryField<Type, PatchField, BoundaryMesh>
|
|
void operator==(const Boundary&);
|
|
|
|
//- Forced assignment to FieldField<PatchField, Type>
|
|
void operator==(const FieldField<PatchField, Type>&);
|
|
|
|
//- Forced assignment to Type
|
|
void operator==(const Type&);
|
|
};
|
|
|
|
|
|
private:
|
|
|
|
// Private data
|
|
|
|
//- Current time index.
|
|
// Used to trigger the storing of the old-time value
|
|
mutable label timeIndex_;
|
|
|
|
//- Pointer to old time field
|
|
mutable GeometricField<Type, PatchField, GeoMesh>* field0Ptr_;
|
|
|
|
//- Pointer to previous iteration (used for under-relaxation)
|
|
mutable GeometricField<Type, PatchField, GeoMesh>* fieldPrevIterPtr_;
|
|
|
|
//- Boundary Type field containing boundary field values
|
|
Boundary boundaryField_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Read the field from the dictionary
|
|
void readFields(const dictionary&);
|
|
|
|
//- Read the field - create the field dictionary on-the-fly
|
|
void readFields();
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("GeometricField");
|
|
|
|
|
|
// Public typedefs
|
|
|
|
typedef typename Field<Type>::cmptType cmptType;
|
|
|
|
// Static Member Functions
|
|
|
|
//- Return a null geometric field
|
|
inline static const GeometricField<Type, PatchField, GeoMesh>& null();
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Constructor given IOobject, mesh, dimensions and patch type.
|
|
// This allocates storage for the field but not values.
|
|
// Used only within this class to create TEMPORARY variables
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const Mesh&,
|
|
const dimensionSet&,
|
|
const word& patchFieldType=PatchField<Type>::calculatedType()
|
|
);
|
|
|
|
//- Constructor given IOobject, mesh, dimensions and patch types.
|
|
// This allocates storage for the field but not values.
|
|
// Used only within this class to create TEMPORARY variables
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const Mesh&,
|
|
const dimensionSet&,
|
|
const wordList& wantedPatchTypes,
|
|
const wordList& actualPatchTypes = wordList()
|
|
);
|
|
|
|
//- Constructor given IOobject, mesh, dimensioned<Type> and patch type.
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const Mesh&,
|
|
const dimensioned<Type>&,
|
|
const word& patchFieldType=PatchField<Type>::calculatedType()
|
|
);
|
|
|
|
//- Constructor given IOobject, mesh, dimensioned<Type> and patch types.
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const Mesh&,
|
|
const dimensioned<Type>&,
|
|
const wordList& wantedPatchTypes,
|
|
const wordList& actualPatchTypes = wordList()
|
|
);
|
|
|
|
//- Constructor from components
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const Internal&,
|
|
const PtrList<PatchField<Type>>&
|
|
);
|
|
|
|
//- Constructor from components
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const Mesh&,
|
|
const dimensionSet&,
|
|
const Field<Type>&,
|
|
const PtrList<PatchField<Type>>&
|
|
);
|
|
|
|
//- Construct and read given IOobject
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const Mesh&
|
|
);
|
|
|
|
//- Construct from dictionary
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const Mesh&,
|
|
const dictionary&
|
|
);
|
|
|
|
//- Construct as copy
|
|
GeometricField
|
|
(
|
|
const GeometricField<Type, PatchField, GeoMesh>&
|
|
);
|
|
|
|
//- Construct as copy of tmp<GeometricField> deleting argument
|
|
#ifndef NoConstructFromTmp
|
|
GeometricField
|
|
(
|
|
const tmp<GeometricField<Type, PatchField, GeoMesh>>&
|
|
);
|
|
#endif
|
|
|
|
//- Construct as copy resetting IO parameters
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const GeometricField<Type, PatchField, GeoMesh>&
|
|
);
|
|
|
|
//- Construct as copy of tmp<GeometricField> resetting IO parameters
|
|
#ifndef NoConstructFromTmp
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const tmp<GeometricField<Type, PatchField, GeoMesh>>&
|
|
);
|
|
#endif
|
|
|
|
//- Construct as copy resetting name
|
|
GeometricField
|
|
(
|
|
const word& newName,
|
|
const GeometricField<Type, PatchField, GeoMesh>&
|
|
);
|
|
|
|
//- Construct as copy resetting name
|
|
#ifndef NoConstructFromTmp
|
|
GeometricField
|
|
(
|
|
const word& newName,
|
|
const tmp<GeometricField<Type, PatchField, GeoMesh>>&
|
|
);
|
|
#endif
|
|
|
|
//- Construct as copy resetting IO parameters and patch type
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const GeometricField<Type, PatchField, GeoMesh>&,
|
|
const word& patchFieldType
|
|
);
|
|
|
|
//- Construct as copy resetting IO parameters and boundary types
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const GeometricField<Type, PatchField, GeoMesh>&,
|
|
const wordList& patchFieldTypes,
|
|
const wordList& actualPatchTypes = wordList()
|
|
);
|
|
|
|
//- Construct as copy resetting IO parameters and boundary types
|
|
#ifndef NoConstructFromTmp
|
|
GeometricField
|
|
(
|
|
const IOobject&,
|
|
const tmp<GeometricField<Type, PatchField, GeoMesh>>&,
|
|
const wordList& patchFieldTypes,
|
|
const wordList& actualPatchTypes = wordList()
|
|
);
|
|
#endif
|
|
|
|
|
|
//- Destructor
|
|
virtual ~GeometricField();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Return a reference to the dimensioned internal field
|
|
// Note: this increments the event counter and checks the
|
|
// old-time fields; avoid in loops.
|
|
Internal& ref();
|
|
|
|
//- Return a const-reference to the dimensioned internal field
|
|
inline const Internal& internalField() const;
|
|
|
|
//- Return a const-reference to the dimensioned internal field
|
|
// of a "vol" field. Useful in the formulation of source-terms
|
|
// for FV equations
|
|
inline const Internal& v() const;
|
|
|
|
//- Return a reference to the internal field
|
|
// Note: this increments the event counter and checks the
|
|
// old-time fields; avoid in loops.
|
|
typename Internal::FieldType& primitiveFieldRef();
|
|
|
|
//- Return a const-reference to the internal field
|
|
inline const typename Internal::FieldType& primitiveField() const;
|
|
|
|
//- Return a reference to the boundary field
|
|
// Note: this increments the event counter and checks the
|
|
// old-time fields; avoid in loops.
|
|
Boundary& boundaryFieldRef();
|
|
|
|
//- Return const-reference to the boundary field
|
|
inline const Boundary& boundaryField() const;
|
|
|
|
//- Return the time index of the field
|
|
inline label timeIndex() const;
|
|
|
|
//- Return the time index of the field
|
|
inline label& timeIndex();
|
|
|
|
//- Store the old-time fields
|
|
void storeOldTimes() const;
|
|
|
|
//- Store the old-time field
|
|
void storeOldTime() const;
|
|
|
|
//- Return the number of old time fields stored
|
|
label nOldTimes() const;
|
|
|
|
//- Return old time field
|
|
const GeometricField<Type, PatchField, GeoMesh>& oldTime() const;
|
|
|
|
//- Return non-const old time field
|
|
// (Not a good idea but it is used for sub-cycling)
|
|
GeometricField<Type, PatchField, GeoMesh>& oldTime();
|
|
|
|
//- Store the field as the previous iteration value
|
|
void storePrevIter() const;
|
|
|
|
//- Return previous iteration field
|
|
const GeometricField<Type, PatchField, GeoMesh>& prevIter() const;
|
|
|
|
//- Correct boundary field
|
|
void correctBoundaryConditions();
|
|
|
|
//- Does the field need a reference level for solution
|
|
bool needReference() const;
|
|
|
|
//- Return a component of the field
|
|
tmp<GeometricField<cmptType, PatchField, GeoMesh>> component
|
|
(
|
|
const direction
|
|
) const;
|
|
|
|
//- WriteData member function required by regIOobject
|
|
bool writeData(Ostream&) const;
|
|
|
|
//- Return transpose (only if it is a tensor field)
|
|
tmp<GeometricField<Type, PatchField, GeoMesh>> T() const;
|
|
|
|
//- Relax field (for steady-state solution).
|
|
// alpha = 1 : no relaxation
|
|
// alpha < 1 : relaxation
|
|
// alpha = 0 : do nothing
|
|
void relax(const scalar alpha);
|
|
|
|
//- Relax field (for steady-state solution).
|
|
// alpha is read from controlDict
|
|
void relax();
|
|
|
|
//- Select the final iteration parameters if `final' is true
|
|
// by returning the field name + "Final"
|
|
// otherwise the standard parameters by returning the field name
|
|
word select(bool final) const;
|
|
|
|
//- Helper function to write the min and max to an Ostream
|
|
void writeMinMax(Ostream& os) const;
|
|
|
|
|
|
// Member function *this operators
|
|
|
|
void negate();
|
|
|
|
void replace
|
|
(
|
|
const direction,
|
|
const GeometricField<cmptType, PatchField, GeoMesh>&
|
|
);
|
|
|
|
void replace
|
|
(
|
|
const direction,
|
|
const dimensioned<cmptType>&
|
|
);
|
|
|
|
void max(const dimensioned<Type>&);
|
|
void min(const dimensioned<Type>&);
|
|
|
|
void max
|
|
(
|
|
const GeometricField<Type, PatchField, GeoMesh>&,
|
|
const dimensioned<Type>&
|
|
);
|
|
|
|
void min
|
|
(
|
|
const GeometricField<Type, PatchField, GeoMesh>&,
|
|
const dimensioned<Type>&
|
|
);
|
|
|
|
void scale
|
|
(
|
|
const GeometricField<Type, PatchField, GeoMesh>&,
|
|
const GeometricField<Type, PatchField, GeoMesh>&
|
|
);
|
|
|
|
void scale
|
|
(
|
|
const GeometricField<Type, PatchField, GeoMesh>&,
|
|
const dimensioned<Type>&
|
|
);
|
|
|
|
|
|
// Member operators
|
|
|
|
//- Return a const-reference to the dimensioned internal field
|
|
// Useful in the formulation of source-terms for FV equations
|
|
inline const Internal& operator()() const;
|
|
|
|
void operator=(const GeometricField<Type, PatchField, GeoMesh>&);
|
|
void operator=(const tmp<GeometricField<Type, PatchField, GeoMesh>>&);
|
|
void operator=(const dimensioned<Type>&);
|
|
|
|
void operator==(const tmp<GeometricField<Type, PatchField, GeoMesh>>&);
|
|
void operator==(const dimensioned<Type>&);
|
|
|
|
void operator+=(const GeometricField<Type, PatchField, GeoMesh>&);
|
|
void operator+=(const tmp<GeometricField<Type, PatchField, GeoMesh>>&);
|
|
|
|
void operator-=(const GeometricField<Type, PatchField, GeoMesh>&);
|
|
void operator-=(const tmp<GeometricField<Type, PatchField, GeoMesh>>&);
|
|
|
|
void operator*=(const GeometricField<scalar, PatchField, GeoMesh>&);
|
|
void operator*=(const tmp<GeometricField<scalar,PatchField,GeoMesh>>&);
|
|
|
|
void operator/=(const GeometricField<scalar, PatchField, GeoMesh>&);
|
|
void operator/=(const tmp<GeometricField<scalar,PatchField,GeoMesh>>&);
|
|
|
|
void operator+=(const dimensioned<Type>&);
|
|
void operator-=(const dimensioned<Type>&);
|
|
|
|
void operator*=(const dimensioned<scalar>&);
|
|
void operator/=(const dimensioned<scalar>&);
|
|
|
|
|
|
// Ostream operators
|
|
|
|
friend Ostream& operator<< <Type, PatchField, GeoMesh>
|
|
(
|
|
Ostream&,
|
|
const GeometricField<Type, PatchField, GeoMesh>&
|
|
);
|
|
|
|
friend Ostream& operator<< <Type, PatchField, GeoMesh>
|
|
(
|
|
Ostream&,
|
|
const tmp<GeometricField<Type, PatchField, GeoMesh>>&
|
|
);
|
|
};
|
|
|
|
|
|
template<class Type, template<class> class PatchField, class GeoMesh>
|
|
Ostream& operator<<
|
|
(
|
|
Ostream&,
|
|
const typename GeometricField<Type, PatchField, GeoMesh>::
|
|
Boundary&
|
|
);
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "GeometricFieldI.H"
|
|
|
|
#ifdef NoRepository
|
|
#include "GeometricField.C"
|
|
#endif
|
|
|
|
#include "GeometricFieldFunctions.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|