OpenFOAM logo
Open Source CFD Toolkit

CoupledTetPointPatchField.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     CoupledTetPointPatchField
00027 
00028 Description
00029 
00030 SourceFiles
00031     CoupledTetPointPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef CoupledTetPointPatchField_H
00036 #define CoupledTetPointPatchField_H
00037 
00038 #include "TetPointPatchField.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                   Class CoupledTetPointPatchField Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<template<class> class PatchField, class PointPatch, class Type>
00050 class CoupledTetPointPatchField
00051 :
00052     public PatchField<Type>
00053 {
00054 
00055 public:
00056 
00057     // Constructors
00058 
00059         //- Construct from patch and internal field
00060         CoupledTetPointPatchField
00061         (
00062             const PointPatch&,
00063             const Field<Type>&
00064         );
00065 
00066         //- Construct by mapping given patchField<Type> onto a new patch
00067         CoupledTetPointPatchField
00068         (
00069             const CoupledTetPointPatchField<PatchField, PointPatch, Type>&,
00070             const PointPatch&,
00071             const Field<Type>&,
00072             const TetPointPatchFieldMapper&
00073         );
00074 
00075         //- Construct and return a clone
00076         virtual autoPtr<PatchField<Type> > clone() const = 0;
00077 
00078         //- Construct as copy setting internal field reference
00079         CoupledTetPointPatchField
00080         (
00081             const CoupledTetPointPatchField<PatchField, PointPatch, Type>&,
00082             const Field<Type>&
00083         );
00084 
00085         //- Construct and return a clone setting internal field reference
00086         virtual autoPtr<PatchField<Type> > clone
00087         (
00088             const Field<Type>& iF
00089         ) const = 0;
00090 
00091 
00092     // Member functions
00093 
00094         // Access
00095 
00096             //- Return true if this patch field is derived from
00097             //  CoupledTetPointPatchField<PatchField, PointPatch, Type>.
00098             virtual bool coupled() const
00099             {
00100                 return true;
00101             }
00102 
00103             //- Evaluate the patch field
00104             virtual void evaluate() = 0;
00105 
00106             //- Add field to internal field
00107             virtual void addField(Field<Type>&) const = 0;
00108 
00109 
00110         // Matrix construction (completion) functionality
00111 
00112             //- Add diagonal/source contributions
00113             virtual void addDiag(scalarField&) const = 0;
00114             virtual void addSource(scalarField&) const = 0;
00115 
00116             //- Add upper/lower contributions
00117             virtual void addUpperLower(scalarField&) const = 0;
00118 
00119             virtual void eliminateUpperLower(scalarField&) const = 0;
00120 
00121             //- Get the cut edge coefficients in Amul order
00122             virtual tmp<scalarField> cutBouCoeffs(const lduMatrix&) const = 0;
00123 
00124             //- Get the cut edge coefficients in Tmul order
00125             virtual tmp<scalarField> cutIntCoeffs(const lduMatrix&) const = 0;
00126 
00127 
00128         // Coupled interface functionality
00129 
00130             //- Initialise neighbour matrix update
00131             virtual void initInterfaceMatrixUpdate
00132             (
00133                 const scalarField&,
00134                 scalarField&,
00135                 const lduMatrix&,
00136                 const scalarField&,
00137                 const direction,
00138                 const bool
00139             ) const
00140             {}
00141 
00142             //- Update result field based on interface functionality
00143             virtual void updateInterfaceMatrix
00144             (
00145                 const scalarField&,
00146                 scalarField&,
00147                 const lduMatrix&,
00148                 const scalarField&,
00149                 const direction
00150             ) const = 0;
00151 };
00152 
00153 
00154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00155 
00156 } // End namespace Foam
00157 
00158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00159 
00160 #ifdef NoRepository
00161 #    include "CoupledTetPointPatchField.C"
00162 #endif
00163 
00164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00165 
00166 #endif
00167 
00168 // ************************************************************************* //
For further information go to www.openfoam.org