1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/SNES/SNESQNSetScaleType.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESQNSetScaleType</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.14.5 v3.14.5 docs/manualpages/SNES/SNESQNSetScaleType.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESQNSetScaleType"><H1>SNESQNSetScaleType</H1></A>
Sets the scaling type for the inner inverse Jacobian in <A HREF="../SNES/SNESQN.html#SNESQN">SNESQN</A>.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/SNESQNSetScaleType.html#SNESQNSetScaleType">SNESQNSetScaleType</A>(<A HREF="../SNES/SNES.html#SNES">SNES</A> snes, SNESQNScaleType stype)
</PRE>
Logically Collective on <A HREF="../SNES/SNES.html#SNES">SNES</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>snes </B></TD><TD>- the iterative context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>stype </B></TD><TD>- scale type
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_qn_scale_type <diagonal,none,scalar,jacobian></B></TD></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">SNESQNScaleTypes</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SNES_QN_SCALE_NONE </B></TD><TD>- don't scale the problem
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SNES_QN_SCALE_SCALAR </B></TD><TD>- use shanno scaling
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SNES_QN_SCALE_DIAGONAL </B></TD><TD>- scale with a diagonalized BFGS formula (see Gilbert and Lemarechal 1989), available
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SNES_QN_SCALE_JACOBIAN </B></TD><TD>- scale by solving a linear system coming from the Jacobian you provided with <A HREF="../SNES/SNESSetJacobian.html#SNESSetJacobian">SNESSetJacobian</A>() computed at the first iteration
of QN and at ever restart.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNES.html#SNES">SNES</A>, <A HREF="../SNES/SNESQN.html#SNESQN">SNESQN</A>, <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A>, SNESQNScaleType, SNESetJacobian()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/snes/impls/qn/qn.c.html#SNESQNSetScaleType">src/snes/impls/qn/qn.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/snes/impls/qn/qn.c.html#SNESQNSetScaleType_QN">SNESQNSetScaleType_QN in src/snes/impls/qn/qn.c</A><BR>
<BR><A HREF="./index.html">Index of all SNES routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|
