OpenFOAM-dev / data /src /OpenFOAM /matrices /lduMatrix /lduAddressing /lduInterfaceFields /lduInterfaceField /lduInterfaceField.H
| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | |
| \\ / O peration | Website: https://openfoam.org | |
| \\ / A nd | Copyright (C) 2011-2020 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::lduInterfaceField | |
| Description | |
| An abstract base class for implicitly-coupled interface fields | |
| e.g. processor and cyclic patch fields. | |
| SourceFiles | |
| lduInterfaceField.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| class lduMatrix; | |
| /*---------------------------------------------------------------------------*\ | |
| Class lduInterfaceField Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class lduInterfaceField | |
| { | |
| // Private Data | |
| //- Reference to the coupled patch this field is defined for | |
| const lduInterface& interface_; | |
| //- Update index used so that updateInterfaceMatrix is called only once | |
| // during the construction of the matrix | |
| bool updatedMatrix_; | |
| public: | |
| //- Runtime type information | |
| TypeName("lduInterfaceField"); | |
| // Constructors | |
| //- Construct given coupled patch | |
| lduInterfaceField(const lduInterface& patch) | |
| : | |
| interface_(patch), | |
| updatedMatrix_(false) | |
| {} | |
| //- Disallow default bitwise copy construction | |
| lduInterfaceField(const lduInterfaceField&) = delete; | |
| //- Destructor | |
| virtual ~lduInterfaceField(); | |
| // Member Functions | |
| // Access | |
| //- Return the interface | |
| const lduInterface& interface() const | |
| { | |
| return interface_; | |
| } | |
| //- Return the interface type | |
| virtual const word& interfaceFieldType() const | |
| { | |
| return type(); | |
| } | |
| // Coupled interface matrix update | |
| //- Whether matrix has been updated | |
| bool updatedMatrix() const | |
| { | |
| return updatedMatrix_; | |
| } | |
| //- Whether matrix has been updated | |
| bool& updatedMatrix() | |
| { | |
| return updatedMatrix_; | |
| } | |
| //- Is all data available | |
| virtual bool ready() const | |
| { | |
| return true; | |
| } | |
| //- Initialise neighbour matrix update | |
| virtual void initInterfaceMatrixUpdate | |
| ( | |
| scalarField&, | |
| const scalarField&, | |
| const scalarField&, | |
| const direction, | |
| const Pstream::commsTypes commsType | |
| ) const | |
| {} | |
| //- Update result field based on interface functionality | |
| virtual void updateInterfaceMatrix | |
| ( | |
| scalarField&, | |
| const scalarField&, | |
| const scalarField&, | |
| const direction, | |
| const Pstream::commsTypes commsType | |
| ) const = 0; | |
| // Member Operators | |
| //- Disallow default bitwise assignment | |
| void operator=(const lduInterfaceField&) = delete; | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |