Chaste
Commit::1fd4e48e3990e67db148bc1bc4cf6991a0049d0c
SimpleNewtonNonlinearSolver.hpp
1
/*
2
3
Copyright (c) 2005-2024, University of Oxford.
4
All rights reserved.
5
6
University of Oxford means the Chancellor, Masters and Scholars of the
7
University of Oxford, having an administrative office at Wellington
8
Square, Oxford OX1 2JD, UK.
9
10
This file is part of Chaste.
11
12
Redistribution and use in source and binary forms, with or without
13
modification, are permitted provided that the following conditions are met:
14
* Redistributions of source code must retain the above copyright notice,
15
this list of conditions and the following disclaimer.
16
* Redistributions in binary form must reproduce the above copyright notice,
17
this list of conditions and the following disclaimer in the documentation
18
and/or other materials provided with the distribution.
19
* Neither the name of the University of Oxford nor the names of its
20
contributors may be used to endorse or promote products derived from this
21
software without specific prior written permission.
22
23
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34
*/
35
36
#ifndef SIMPLENEWTONNONLINEARSOLVER_HPP_
37
#define SIMPLENEWTONNONLINEARSOLVER_HPP_
38
39
#include "LinearSystem.hpp"
40
#include "AbstractNonlinearSolver.hpp"
41
#include <vector>
42
46
class
SimpleNewtonNonlinearSolver
:
public
AbstractNonlinearSolver
47
{
48
private
:
49
50
double
mTolerance
;
51
bool
mWriteStats
;
53
std::vector<double>
mTestDampingValues
;
55
public
:
56
61
SimpleNewtonNonlinearSolver
();
62
66
virtual
~SimpleNewtonNonlinearSolver
();
67
115
virtual
Vec
Solve
(PetscErrorCode (*pComputeResidual)(SNES,
Vec
,
Vec
,
void
*),
116
#
if
(PETSC_VERSION_MAJOR==3 && PETSC_VERSION_MINOR>=5)
117
PetscErrorCode (*pComputeJacobian)(SNES,
Vec
,
Mat
,
Mat
,
void
*),
118
#
else
119
PetscErrorCode (*pComputeJacobian)(SNES,
Vec
,
Mat
*,
Mat
*,MatStructure*,
void
*),
120
#endif
121
Vec
initialGuess,
122
unsigned
fill,
123
void
* pContext);
124
130
void
SetTolerance
(
double
tolerance);
131
137
void
SetWriteStats
(
bool
writeStats =
true
)
138
{
139
mWriteStats
= writeStats;
140
}
141
};
142
143
#endif
/*SIMPLENEWTONNONLINEARSOLVER_HPP_*/
AbstractNonlinearSolver
Definition
AbstractNonlinearSolver.hpp:47
Mat
SimpleNewtonNonlinearSolver
Definition
SimpleNewtonNonlinearSolver.hpp:47
SimpleNewtonNonlinearSolver::mTestDampingValues
std::vector< double > mTestDampingValues
Definition
SimpleNewtonNonlinearSolver.hpp:53
SimpleNewtonNonlinearSolver::SimpleNewtonNonlinearSolver
SimpleNewtonNonlinearSolver()
Definition
SimpleNewtonNonlinearSolver.cpp:41
SimpleNewtonNonlinearSolver::mTolerance
double mTolerance
Definition
SimpleNewtonNonlinearSolver.hpp:50
SimpleNewtonNonlinearSolver::SetTolerance
void SetTolerance(double tolerance)
Definition
SimpleNewtonNonlinearSolver.cpp:174
SimpleNewtonNonlinearSolver::SetWriteStats
void SetWriteStats(bool writeStats=true)
Definition
SimpleNewtonNonlinearSolver.hpp:137
SimpleNewtonNonlinearSolver::Solve
virtual Vec Solve(PetscErrorCode(*pComputeResidual)(SNES, Vec, Vec, void *), PetscErrorCode(*pComputeJacobian)(SNES, Vec, Mat *, Mat *, MatStructure *, void *), Vec initialGuess, unsigned fill, void *pContext)
Definition
SimpleNewtonNonlinearSolver.cpp:57
SimpleNewtonNonlinearSolver::~SimpleNewtonNonlinearSolver
virtual ~SimpleNewtonNonlinearSolver()
Definition
SimpleNewtonNonlinearSolver.cpp:54
SimpleNewtonNonlinearSolver::mWriteStats
bool mWriteStats
Definition
SimpleNewtonNonlinearSolver.hpp:51
Vec
linalg
src
SimpleNewtonNonlinearSolver.hpp
Generated by
1.9.8