OpenFOAM-dev / data /src /finiteVolume /fields /fvPatchFields /basic /coupled /coupledFvPatchField.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::coupledFvPatchField | |
| Description | |
| Abstract base class for coupled patches. | |
| SourceFiles | |
| coupledFvPatchField.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class coupledFvPatch Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| template<class Type> | |
| class coupledFvPatchField | |
| : | |
| public LduInterfaceField<Type>, | |
| public fvPatchField<Type> | |
| { | |
| public: | |
| //- Runtime type information | |
| TypeName(coupledFvPatch::typeName_()); | |
| // Constructors | |
| //- Construct from patch and internal field | |
| coupledFvPatchField | |
| ( | |
| const fvPatch&, | |
| const DimensionedField<Type, fvMesh>& | |
| ); | |
| //- Construct from patch and internal field and patch field | |
| coupledFvPatchField | |
| ( | |
| const fvPatch&, | |
| const DimensionedField<Type, fvMesh>&, | |
| const Field<Type>& | |
| ); | |
| //- Construct from patch, internal field and dictionary | |
| coupledFvPatchField | |
| ( | |
| const fvPatch&, | |
| const DimensionedField<Type, fvMesh>&, | |
| const dictionary&, | |
| const bool valueRequired=true | |
| ); | |
| //- Construct by mapping the given coupledFvPatchField onto a new patch | |
| coupledFvPatchField | |
| ( | |
| const coupledFvPatchField<Type>&, | |
| const fvPatch&, | |
| const DimensionedField<Type, fvMesh>&, | |
| const fieldMapper& | |
| ); | |
| //- Disallow copy without setting internal field reference | |
| coupledFvPatchField(const coupledFvPatchField<Type>&) = delete; | |
| //- Copy constructor setting internal field reference | |
| coupledFvPatchField | |
| ( | |
| const coupledFvPatchField<Type>&, | |
| const DimensionedField<Type, fvMesh>& | |
| ); | |
| //- Construct and return a clone | |
| virtual tmp<fvPatchField<Type>> clone | |
| ( | |
| const DimensionedField<Type, fvMesh>& | |
| ) const = 0; | |
| // Member Functions | |
| using fvPatchField<Type>::patch; | |
| using fvPatchField<Type>::patchInternalField; | |
| using fvPatchField<Type>::patchNeighbourField; | |
| // Access | |
| //- Return true if this patch field is derived from | |
| // coupledFvPatchField<Type>. | |
| virtual bool coupled() const | |
| { | |
| return true; | |
| } | |
| //- Return neighbour field of internal field | |
| virtual tmp<Field<Type>> patchNeighbourField | |
| ( | |
| const Pstream::commsTypes commsType = | |
| Pstream::commsTypes::blocking | |
| ) const = 0; | |
| // Mapping functions | |
| //- Map the given fvPatchField onto this fvPatchField | |
| virtual void map(const fvPatchField<Type>&, const fieldMapper&); | |
| // Evaluation functions | |
| //- Return patch-normal gradient | |
| virtual tmp<Field<Type>> snGrad | |
| ( | |
| const scalarField& deltaCoeffs | |
| ) const; | |
| //- Return patch-normal gradient | |
| virtual tmp<Field<Type>> snGrad() const | |
| { | |
| NotImplemented; | |
| return *this; | |
| } | |
| //- Initialise the evaluation of the patch field | |
| virtual void initEvaluate | |
| ( | |
| const Pstream::commsTypes commsType | |
| ); | |
| //- Evaluate the patch field, but don't update the coeffs | |
| void evaluateNoUpdateCoeffs(); | |
| //- Evaluate the patch field | |
| virtual void evaluate | |
| ( | |
| const Pstream::commsTypes commsType | |
| ); | |
| //- Return the matrix diagonal coefficients corresponding to the | |
| // evaluation of the value of this patchField with given weights | |
| virtual tmp<Field<Type>> valueInternalCoeffs | |
| ( | |
| const tmp<scalarField>& | |
| ) const; | |
| //- Return the matrix source coefficients corresponding to the | |
| // evaluation of the value of this patchField with given weights | |
| virtual tmp<Field<Type>> valueBoundaryCoeffs | |
| ( | |
| const tmp<scalarField>& | |
| ) const; | |
| //- Return the matrix diagonal coefficients corresponding to the | |
| // evaluation of the gradient of this patchField | |
| virtual tmp<Field<Type>> gradientInternalCoeffs | |
| ( | |
| const scalarField& deltaCoeffs | |
| ) const; | |
| //- Return the matrix diagonal coefficients corresponding to the | |
| // evaluation of the gradient of this patchField | |
| virtual tmp<Field<Type>> gradientInternalCoeffs() const; | |
| //- Return the matrix source coefficients corresponding to the | |
| // evaluation of the gradient of this patchField | |
| virtual tmp<Field<Type>> gradientBoundaryCoeffs | |
| ( | |
| const scalarField& deltaCoeffs | |
| ) const; | |
| //- Return the matrix source coefficients corresponding to the | |
| // evaluation of the gradient of this patchField | |
| virtual tmp<Field<Type>> gradientBoundaryCoeffs() const; | |
| // Coupled interface functionality | |
| //- Update result field based on interface functionality | |
| virtual void updateInterfaceMatrix | |
| ( | |
| scalarField& result, | |
| const scalarField& psiInternal, | |
| const scalarField& coeffs, | |
| const direction, | |
| const Pstream::commsTypes commsType | |
| ) const = 0; | |
| //- Update result field based on interface functionality | |
| virtual void updateInterfaceMatrix | |
| ( | |
| Field<Type>&, | |
| const Field<Type>&, | |
| const scalarField&, | |
| const Pstream::commsTypes commsType | |
| ) const = 0; | |
| //- Write | |
| virtual void write(Ostream&) const; | |
| // Member Operators | |
| //- Inherit assignment | |
| using fvPatchField<Type>::operator=; | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |