src/OpenFOAM/matrices/constraint/constraint.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     constraint
  27
  28 Description
  29     A storage mechanism which allows setting of the fixed value and
  30     consequently recovering the equation for a single row of the matrix as
  31     well as the source. The equation is taken out of the matrix using a
  32     variant of compact matrix storage mechanism.
  33
  34 SourceFiles
  35     constraint.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef constraint_H
  40 #define constraint_H
  41
  42 #include "labelList.H"
  43 #include "scalarField.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 template<class Type>
  51 class constraint;
  52
  53 template<class Type>
  54 Ostream& operator<<(Ostream&, const constraint<Type>&);
  55
  56
  57 /*---------------------------------------------------------------------------*\
  58                         Class constraint Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 template<class Type>
  62 class constraint
  63 {
  64     // Private data
  65
  66         //- Matrix row ID
  67         label rowID_;
  68
  69         //- Fixed value
  70         Type value_;
  71
  72         //- Fixed components (0-1) 1 = fixed, 0 = free
  73         Type fixedComponents_;
  74
  75         //- Are matrix coefficients set?
  76         bool matrixCoeffsSet_;
  77
  78         //- Diagonal coefficient
  79         scalar diagCoeff_;
  80
  81         //- Source
  82         Type source_;
  83
  84         //- Upper coefficients
  85         scalarField* upperCoeffsOwnerPtr_;
  86
  87         scalarField* upperCoeffsNeighbourPtr_;
  88
  89         //- Lower coefficients
  90         scalarField* lowerCoeffsOwnerPtr_;
  91
  92         scalarField* lowerCoeffsNeighbourPtr_;
  93
  94     // Private Member Functions
  95
  96         //- Return scalar component of value. Used to simplify templating
  97         scalar componentOfValue(const Type&, const direction) const;
  98
  99
 100 public:
 101
 102
 103     // Constructors
 104
 105         //- Construct from components
 106         constraint
 107         (
 108             const label row,
 109             const Type value,
 110             const Type& fixedCmpts = pTraits<Type>::one
 111         );
 112
 113         //- Construct from matrix and other components
 114         template<template<class> class Matrix>
 115         constraint
 116         (
 117             const Matrix<Type>&,
 118             const label row,
 119             const Type value,
 120             const Type& fixedCmpts = pTraits<Type>::one
 121         );
 122
 123         //- Construct as copy
 124         constraint(const constraint&);
 125
 126         //- Construct from Istream
 127         constraint(Istream&);
 128
 129
 130     // Destructor
 131
 132         ~constraint();
 133
 134
 135     // Member Functions
 136
 137         //- Return matrix row ID
 138         label rowID() const
 139         {
 140             return rowID_;
 141         }
 142
 143         //- Return fixed value
 144         Type value() const
 145         {
 146             return value_;
 147         }
 148
 149         //- Return map of fixed components
 150         const Type& fixedComponents() const
 151         {
 152             return fixedComponents_;
 153         }
 154
 155         //- Return diagonal coefficient
 156         scalar diagCoeff() const;
 157
 158         //- Return source
 159         Type source() const;
 160
 161         //- Return off-diagonal coefficients
 162         const scalarField& upperCoeffsOwner() const;
 163
 164         const scalarField& upperCoeffsNeighbour() const;
 165
 166         const scalarField& lowerCoeffsOwner() const;
 167
 168         const scalarField& lowerCoeffsNeighbour() const;
 169
 170         //- Combine with existing equation
 171         void combine(const constraint&);
 172
 173         //- Set matrix coefficients
 174         template<template<class> class Matrix>
 175         void setMatrix(const Matrix<Type>&);
 176
 177
 178         //- Eliminate equation
 179         template<template<class> class Matrix>
 180         static void eliminateEquation(Matrix<Type>&, const label, const Type&);
 181
 182         //- Eliminate equation
 183         template<template<class> class Matrix>
 184         void eliminateEquation(Matrix<Type>&) const;
 185
 186         //- Eliminate component equation with given direction and
 187         //  component source
 188         template<template<class> class Matrix>
 189         void eliminateEquation
 190         (
 191             Matrix<Type>&,
 192             const direction,
 193             scalarField&
 194         ) const;
 195
 196
 197         //- Set source in eliminated equation
 198         template<template<class> class Matrix>
 199         static void setSource(Matrix<Type>&, const label, const Type&);
 200
 201         //- Set source in eliminated equation
 202         template<template<class> class Matrix>
 203         void setSource(Matrix<Type>&) const;
 204
 205         //- Set source and diagonal in eliminated equation
 206         template<template<class> class Matrix>
 207         void setSourceDiag
 208         (
 209             Matrix<Type>&,
 210             const direction,
 211             scalarField& psiCmpt,
 212             scalarField& sourceCmpt
 213         ) const;
 214
 215
 216         //- Reconstruct matrix coefficients
 217         template<template<class> class Matrix>
 218         void reconstructMatrix(Matrix<Type>&) const;
 219
 220         //- Clear matrix coefficients
 221         void clearMatrix();
 222
 223
 224     // Member Operators
 225
 226         void operator=(const constraint<Type>&);
 227
 228
 229     // Ostream Operator
 230
 231         friend Ostream& operator<< <Type>
 232         (
 233             Ostream&,
 234             const constraint<Type>&
 235         );
 236 };
 237
 238
 239 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 240
 241 } // End namespace Foam
 242
 243 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 244
 245 #ifdef NoRepository
 246 #    include "constraint.C"
 247 #    include "constraintTools.C"
 248 #endif
 249
 250 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 251
 252 #include "scalarConstraint.H"
 253
 254 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 255
 256 #endif
 257
 258 // ************************************************************************* //