Files
openfoam/src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduInterfaceField/LduInterfaceField.H

135 lines
3.8 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::LduInterfaceField
Description
An abstract base class for implicitly-coupled interface fields
e.g. processor and cyclic patch fields.
SourceFiles
LduInterfaceField.C
\*---------------------------------------------------------------------------*/
#ifndef LduInterfaceField_H
#define LduInterfaceField_H
#include "lduInterfaceField.H"
#include "primitiveFieldsFwd.H"
#include "Pstream.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
class lduMatrix;
/*---------------------------------------------------------------------------*\
Class LduInterfaceField Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class LduInterfaceField
:
public lduInterfaceField
{
// Private Member Functions
//- Disallow default bitwise copy construct
LduInterfaceField(const LduInterfaceField&);
//- Disallow default bitwise assignment
void operator=(const LduInterfaceField&);
public:
//- Runtime type information
TypeName("LduInterfaceField");
// Constructors
//- Construct given coupled patch
LduInterfaceField(const lduInterface& patch)
:
lduInterfaceField(patch)
{}
//- Destructor
virtual ~LduInterfaceField();
// Member Functions
// Coupled interface functionality
//- Inherit initInterfaceMatrixUpdate from lduInterfaceField
using lduInterfaceField::initInterfaceMatrixUpdate;
//- Initialise neighbour matrix update
virtual void initInterfaceMatrixUpdate
(
Field<Type>&,
const Field<Type>&,
const scalarField&,
const Pstream::commsTypes commsType
) const
{}
//- Inherit updateInterfaceMatrix from lduInterfaceField
using lduInterfaceField::updateInterfaceMatrix;
//- Update result field based on interface functionality
virtual void updateInterfaceMatrix
(
Field<Type>&,
const Field<Type>&,
const scalarField&,
const Pstream::commsTypes commsType
) const = 0;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "LduInterfaceField.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //