PPCR.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2019-2020 Mattijs Janssens
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "PPCR.H"
29 #include "PrecisionAdaptor.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
36 
37  lduMatrix::solver::addsymMatrixConstructorToTable<PPCR>
39 }
40 
41 
42 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
43 
44 Foam::PPCR::PPCR
45 (
46  const word& fieldName,
47  const lduMatrix& matrix,
48  const FieldField<Field, scalar>& interfaceBouCoeffs,
49  const FieldField<Field, scalar>& interfaceIntCoeffs,
50  const lduInterfaceFieldPtrsList& interfaces,
51  const dictionary& solverControls
52 )
53 :
54  PPCG
55  (
56  fieldName,
57  matrix,
58  interfaceBouCoeffs,
59  interfaceIntCoeffs,
60  interfaces,
61  solverControls
62  )
63 {}
64 
65 
66 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
67 
69 (
70  scalarField& psi_s,
71  const scalarField& source,
72  const direction cmpt
73 ) const
74 {
76  return PPCG::scalarSolveCG
77  (
78  tpsi.ref(),
80  cmpt,
81  false // operate in residual mode
82  );
83 }
84 
85 
86 // ************************************************************************* //
PPCR.H
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:63
Foam::FieldField
A field of fields is a PtrList of fields with reference counting.
Definition: FieldField.H:49
Foam::lduMatrix
lduMatrix is a general matrix class in which the coefficients are stored as three arrays,...
Definition: lduMatrix.H:79
PrecisionAdaptor.H
Foam::PPCR
Preconditioned pipelined conjugate residuals solver for symmetric lduMatrices using a run-time select...
Definition: PPCR.H:62
Foam::Field
Generic templated field type.
Definition: Field.H:59
Foam::UPtrList
A list of pointers to objects of type <T>, without allocation/deallocation management of the pointers...
Definition: UPtrList.H:58
Foam::PPCR::solve
virtual solverPerformance solve(scalarField &psi, const scalarField &source, const direction cmpt=0) const
Definition: PPCR.C:62
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:119
Foam
Definition: atmBoundaryLayer.C:26
Foam::PrecisionAdaptor
Conversion adaptor for Field/List that either wrap the input as a reference, or creates a temporary p...
Definition: PrecisionAdaptor.H:184
Foam::ConstPrecisionAdaptor
Definition: PrecisionAdaptor.H:53
Foam::direction
uint8_t direction
Definition: direction.H:46
Foam::refPtr< Field< Type > >::ref
T & ref() const
Definition: refPtrI.H:196
Foam::PPCG::scalarSolveCG
solverPerformance scalarSolveCG(solveScalarField &psi, const solveScalarField &source, const direction cmpt, const bool cgMode) const
Definition: PPCG.C:75
Foam::PPCG
Preconditioned pipelined conjugate gradient solver for symmetric lduMatrices using a run-time selecta...
Definition: PPCG.H:60
Foam::SolverPerformance
SolverPerformance is the class returned by the LduMatrix solver containing performance statistics.
Definition: SolverPerformance.H:48
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::addPPCRSymMatrixConstructorToTable_
lduMatrix::solver::addsymMatrixConstructorToTable< PPCR > addPPCRSymMatrixConstructorToTable_
Definition: PPCR.C:31