initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / errorEstimation / errorEstimate / resErrorSup.H
blob51ff8fb59b8d9ccf4744cbde5c93a4376c15fe60
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
11     OpenFOAM is free software; you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
19     for more details.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 InNamespace
26     Foam::resError
28 Description
29     Residual error estimate for the fv source operators
31 SourceFiles
32     resErrorSup.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef resErrorSup_H
37 #define resErrorSup_H
39 #include "errorEstimate.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
47 namespace resError
49     // Implicit source
51         template<class Type>
52         tmp<errorEstimate<Type> > Sp
53         (
54             const volScalarField&,
55             const GeometricField<Type, fvPatchField, volMesh>&
56         );
58         template<class Type>
59         tmp<errorEstimate<Type> > Sp
60         (
61             const tmp<volScalarField>&,
62             const GeometricField<Type, fvPatchField, volMesh>&
63         );
66         template<class Type>
67         tmp<errorEstimate<Type> > Sp
68         (
69             const dimensionedScalar&,
70             const GeometricField<Type, fvPatchField, volMesh>&
71         );
74     // Implicit/Explicit source depending on sign of coefficient
76         template<class Type>
77         tmp<errorEstimate<Type> > SuSp
78         (
79             const volScalarField&,
80             const GeometricField<Type, fvPatchField, volMesh>&
81         );
83         template<class Type>
84         tmp<errorEstimate<Type> > SuSp
85         (
86             const tmp<volScalarField>&,
87             const GeometricField<Type, fvPatchField, volMesh>&
88         );
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 } // End namespace Foam
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 #ifdef NoRepository
100 #   include "resErrorSup.C"
101 #endif
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 #endif
107 // ************************************************************************* //