OpenFOAM-dev / data /src /finiteVolume /fields /GeometricFields /GeometricField /GeometricBoundaryField.H
| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / 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::GeometricBoundaryField | |
| Description | |
| Generic GeometricBoundaryField class. | |
| SourceFiles | |
| GeometricBoundaryField.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| class dictionary; | |
| /*---------------------------------------------------------------------------*\ | |
| Class GeometricBoundaryField Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| template<class Type, class GeoMesh, template<class> class PrimitiveField> | |
| class GeometricBoundaryField | |
| : | |
| public PtrField<typename GeoMesh::template PatchField<Type>> | |
| { | |
| public: | |
| // Public Types | |
| //- Type of boundary mesh on which this boundary is instantiated | |
| using BoundaryMesh = typename GeoMesh::BoundaryMesh; | |
| //- Type of the internal field from which this GeometricField is derived | |
| using Internal = DimensionedField<Type, GeoMesh, PrimitiveField>; | |
| //- Type of the patch field of which the Boundary is composed | |
| using PatchField = typename GeoMesh::template PatchField<Type>; | |
| //- Type of the boundary field | |
| using BoundaryField = PtrField<PatchField>; | |
| private: | |
| // Private Data | |
| //- Reference to BoundaryMesh for which this field is defined | |
| const BoundaryMesh& bmesh_; | |
| public: | |
| //- Declare friendship with other geometric boundary fields | |
| template<class Type2, class GeoMesh2, template<class> class PrimitiveField2> | |
| friend class GeometricBoundaryField; | |
| // Constructors | |
| //- Construct from a BoundaryMesh | |
| GeometricBoundaryField(const BoundaryMesh&); | |
| //- Construct from a BoundaryMesh, | |
| // reference to the internal field | |
| // and a patch field type | |
| GeometricBoundaryField | |
| ( | |
| const BoundaryMesh&, | |
| const Internal&, | |
| const word& | |
| ); | |
| //- Construct from a BoundaryMesh, | |
| // reference to the internal field | |
| // and a wordList of patch field types and optionally | |
| // the actual patch types (to override constraint patches) | |
| GeometricBoundaryField | |
| ( | |
| const BoundaryMesh&, | |
| const Internal&, | |
| const wordList& wantedPatchTypes, | |
| const wordList& actualPatchTypes = wordList() | |
| ); | |
| //- Construct from a BoundaryMesh, | |
| // reference to the internal field | |
| // and a PtrField<PatchField> | |
| GeometricBoundaryField | |
| ( | |
| const BoundaryMesh&, | |
| const Internal&, | |
| const PtrField<PatchField>& | |
| ); | |
| //- Construct as copy setting the reference to the internal field | |
| GeometricBoundaryField(const Internal&, const GeometricBoundaryField&); | |
| //- Construct as copy setting the reference to the internal field | |
| template<template<class> class PrimitiveField2> | |
| GeometricBoundaryField | |
| ( | |
| const Internal& field, | |
| const GeometricBoundaryField<Type, GeoMesh, PrimitiveField2>& btf | |
| ); | |
| //- Construct from a BoundaryMesh, | |
| // reference to the internal field | |
| // and a boundary field expression | |
| template<class Expression, class = EnableIfExpressionable<Expression>> | |
| GeometricBoundaryField | |
| ( | |
| const BoundaryMesh&, | |
| const Internal&, | |
| const Expression& | |
| ); | |
| //- Copy constructor deleted | |
| // as it would not set the internalField reference correctly | |
| GeometricBoundaryField(const GeometricBoundaryField&) = delete; | |
| //- Move constructor deleted | |
| // as it would not set the internalField reference correctly | |
| GeometricBoundaryField(GeometricBoundaryField&&) = delete; | |
| //- Construct from dictionary | |
| GeometricBoundaryField | |
| ( | |
| 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 field types | |
| wordList types() const; | |
| //- Return const-reference to the boundary field | |
| const BoundaryField& boundaryField() const | |
| { | |
| return *this; | |
| } | |
| //- Return BoundaryField of the cell values neighbouring | |
| // the boundary | |
| tmp<GeometricBoundaryField> boundaryInternalField() const; | |
| //- Return BoundaryField of the values on the other side of couples | |
| PtrList<Field<Type>> coupledNeighbourField() const; | |
| //- Return BoundaryField with the values on the other side of couples | |
| tmp<GeometricBoundaryField> boundaryNeighbourField() 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; | |
| //- Reset the boundary field contents to the given field | |
| // Used for mesh to mesh mapping | |
| void reset(const GeometricBoundaryField&); | |
| //- Write boundary field as dictionary entry | |
| void writeEntry(const word& keyword, Ostream& os) const; | |
| // Member Operators | |
| //- Inherit PtrField assignment operators | |
| using PtrField<PatchField>::operator=; | |
| //- Inherit PtrField assignment addition operators | |
| using PtrField<PatchField>::operator+=; | |
| //- Inherit PtrField assignment subtractions operators | |
| using PtrField<PatchField>::operator-=; | |
| //- Assignment operator | |
| void operator=(const GeometricBoundaryField&); | |
| //- Move assignment operator | |
| void operator=(GeometricBoundaryField&&); | |
| //- Forced assignment to | |
| // BoundaryField<Type, GeoMesh::template PatchField, BoundaryMesh> | |
| void operator==(const GeometricBoundaryField&); | |
| //- Forced assignment to PtrField<GeoMesh::template PatchField<Type>> | |
| void operator==(const PtrField<PatchField>&); | |
| //- Forced assignment to PtrField expression | |
| template<class Expression, class = EnableIfExpressionable<Expression>> | |
| void operator==(const Expression&); | |
| //- Forced assignment to PtrField<OtherPatchField<Type>> | |
| template<template<class> class OtherPatchField> | |
| void operator==(const PtrField<OtherPatchField<Type>>&); | |
| //- Forced assignment to Type | |
| void operator==(const Type&); | |
| }; | |
| template<class Type, class GeoMesh, template<class> class PrimitiveField> | |
| Ostream& operator<< | |
| ( | |
| Ostream&, | |
| const GeometricBoundaryField<Type, GeoMesh, PrimitiveField>& | |
| ); | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |