src/finiteArea/faMatrices/faScalarMatrix/faScalarMatrix.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  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.
  15
  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.
  20
  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
  24
  25 Class
  26     faScalarMatrix
  27
  28 Description
  29
  30 SourceFiles
  31     faScalarMatrix.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef faScalarMatrix_H
  36 #define faScalarMatrix_H
  37
  38 #include "faMatrix.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  46
  47 // Set reference level for a component of the solution
  48 // on a given patch face
  49 template<>
  50 void faMatrix<scalar>::setComponentReference
  51 (
  52     const label patchi,
  53     const label facei,
  54     const direction,
  55     const scalar value
  56 );
  57
  58 template<>
  59 autoPtr<faMatrix<scalar>::faSolver> faMatrix<scalar>::solver
  60 (
  61     const dictionary&
  62 );
  63
  64 template<>
  65 lduSolverPerformance faMatrix<scalar>::faSolver::solve
  66 (
  67     const dictionary&
  68 );
  69
  70 template<>
  71 lduSolverPerformance faMatrix<scalar>::solve(const dictionary&);
  72
  73 // Return the matrix residual
  74 template<>
  75 tmp<scalarField> faMatrix<scalar>::residual() const;
  76
  77 // H operator
  78 template<>
  79 tmp<areaScalarField> faMatrix<scalar>::H() const;
  80
  81
  82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  83
  84 } // End namespace Foam
  85
  86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  87
  88 #endif
  89
  90 // ************************************************************************* //