#include <JFNKSolver.H>

Public Types
enum	LinearSolverType { Relax, BiCGStab, GMRES, CG, petsc }

Public Member Functions
	~Configuration ()

	Configuration ()

void	parse (const char *a_prefix="JFNKSolver")

Public Attributes
LinearSolverType	m_linearSolverType
	type of linear solver More...

int	m_maxIter
	maximum number of Newton steps; More...

Real	m_absTol
	absolute tolerance for convergence test; More...

Real	m_relTol
	relative tolerance for convergence test; More...

Real	m_BiCGStabRelTol
	BiCGstab solver relative tolerance. More...

int	m_maxBiCGStabIter
	maximum number of BiCGStab iterations More...

Real	m_CGRelTol
	CG solver relative tolerance. More...

int	m_maxCGIter
	maximum number of CG iterations More...

Real	m_GMRESRelTol
	GMRES solver relative tolerance. More...

int	m_maxGMRESIter
	maximum number of GMRES iterations More...

Real	m_RelaxRelTol
	Relax solver relative tolerance. More...

int	m_maxRelaxIter
	maximum number of Relax iterations More...

Real	m_RelaxHang
	hang parameter for RelaxSolver; More...

int	m_normType
	type of norm to test convergence against More...

int	m_verbosity
	verbosity More...

Real	m_vtopSafety
	safety number for viscous tensor op More...

Real	m_vtopRelaxTol
	relax tolerance for viscous tensor op More...

int	m_vtopRelaxMinIter
	minimum number of smnooths in viscous tensor op mg relax More...

int	m_numMGSmooth
	(maximum) number of smooths in mg relax More...

int	m_numMGIter
	number of MG v-cycles per BiCGStab iteration More...

Real	m_h
	size of finite differenc More...

Real	m_err
	parameters that appears in the adaptive calculation of h More...

Real	m_umin
	parameter that appears in the adaptive calculation of h More...

bool	m_hAdaptive
	Use adaptive calculation of h? More...

Real	m_switchRate
	rate at which to switch from Picard to JFNK mode More...

int	m_minPicardIter
	minumum number of Picard Iterations before switching to JFNK More...

Real	m_minStepFactor
	smallest acceptable factor to try when reducing the newton step length More...

bool	m_writeResiduals
	write out residual data frequently: useful for working out why solves fail More...

bool	m_eliminateFastIce
	throw away fast ice at the end of each iteration? More...

Real	m_eliminateFastIceSpeed
	how fast is fast? More...

bool	m_eliminateFastIceEdgeOnly
	throw away fast ice only ice/no ice boundaries More...

Real	m_eliminateRemoteIceTol
	how thin is thin ice? More...

Real	m_eliminateRemoteIceMaxIter
	limit the number of iterations in eliminate remote ice More...

Real	m_muMin
	smallest effective viscosity in ice-covered regions More...

Real	m_muMax
	largest effective viscosity in ice-covered regions More...

bool	m_residualOnly

Real	m_scale

Real	m_artificialDragCoef

Real	m_artificialDragPower

Member Enumeration Documentation

◆ LinearSolverType

enum JFNKSolver::Configuration::LinearSolverType

Enumerator
Relax
BiCGStab
GMRES
CG
petsc

Constructor & Destructor Documentation

◆ ~Configuration()

JFNKSolver::Configuration::~Configuration ( )

◆ Configuration()

JFNKSolver::Configuration::Configuration ( )

Member Function Documentation

◆ parse()

void JFNKSolver::Configuration::parse ( const char * a_prefix = "JFNKSolver" )

since we tuned everthign to m/a, scaling to m/a by default

default is "lazy gsrb"

References IceVelocitySolver::define(), and PETSC.

Referenced by JFNKSolver::parseConfiguration().

Member Data Documentation

◆ m_absTol

Real JFNKSolver::Configuration::m_absTol

absolute tolerance for convergence test;

◆ m_artificialDragCoef

Real JFNKSolver::Configuration::m_artificialDragCoef

◆ m_artificialDragPower

Real JFNKSolver::Configuration::m_artificialDragPower

◆ m_BiCGStabRelTol

Real JFNKSolver::Configuration::m_BiCGStabRelTol

BiCGstab solver relative tolerance.

◆ m_CGRelTol

Real JFNKSolver::Configuration::m_CGRelTol

CG solver relative tolerance.

◆ m_eliminateFastIce

bool JFNKSolver::Configuration::m_eliminateFastIce

throw away fast ice at the end of each iteration?

◆ m_eliminateFastIceEdgeOnly

bool JFNKSolver::Configuration::m_eliminateFastIceEdgeOnly

throw away fast ice only ice/no ice boundaries

◆ m_eliminateFastIceSpeed

Real JFNKSolver::Configuration::m_eliminateFastIceSpeed

how fast is fast?

◆ m_eliminateRemoteIceMaxIter

Real JFNKSolver::Configuration::m_eliminateRemoteIceMaxIter

limit the number of iterations in eliminate remote ice

◆ m_eliminateRemoteIceTol

Real JFNKSolver::Configuration::m_eliminateRemoteIceTol

how thin is thin ice?

◆ m_err

Real JFNKSolver::Configuration::m_err

parameters that appears in the adaptive calculation of h

◆ m_GMRESRelTol

Real JFNKSolver::Configuration::m_GMRESRelTol

GMRES solver relative tolerance.

◆ m_h

Real JFNKSolver::Configuration::m_h

size of finite differenc

◆ m_hAdaptive

bool JFNKSolver::Configuration::m_hAdaptive

Use adaptive calculation of h?

◆ m_linearSolverType

LinearSolverType JFNKSolver::Configuration::m_linearSolverType

type of linear solver

◆ m_maxBiCGStabIter

int JFNKSolver::Configuration::m_maxBiCGStabIter

maximum number of BiCGStab iterations

◆ m_maxCGIter

int JFNKSolver::Configuration::m_maxCGIter

maximum number of CG iterations

◆ m_maxGMRESIter

int JFNKSolver::Configuration::m_maxGMRESIter

maximum number of GMRES iterations

◆ m_maxIter

int JFNKSolver::Configuration::m_maxIter

maximum number of Newton steps;

◆ m_maxRelaxIter

int JFNKSolver::Configuration::m_maxRelaxIter

maximum number of Relax iterations

Referenced by InverseVerticallyIntegratedVelocitySolver::nDoF().

◆ m_minPicardIter

int JFNKSolver::Configuration::m_minPicardIter

minumum number of Picard Iterations before switching to JFNK

This is useful when the first iteration or two of Picard don't get very far, but don't get close enough to the solution to warrant switching to JFNK mode. Default is zero.

◆ m_minStepFactor

Real JFNKSolver::Configuration::m_minStepFactor

smallest acceptable factor to try when reducing the newton step length

◆ m_muMax

Real JFNKSolver::Configuration::m_muMax

largest effective viscosity in ice-covered regions

◆ m_muMin

Real JFNKSolver::Configuration::m_muMin

smallest effective viscosity in ice-covered regions

◆ m_normType

int JFNKSolver::Configuration::m_normType

type of norm to test convergence against

◆ m_numMGIter

int JFNKSolver::Configuration::m_numMGIter

number of MG v-cycles per BiCGStab iteration

◆ m_numMGSmooth

int JFNKSolver::Configuration::m_numMGSmooth

(maximum) number of smooths in mg relax

◆ m_RelaxHang

Real JFNKSolver::Configuration::m_RelaxHang

hang parameter for RelaxSolver;

Referenced by InverseVerticallyIntegratedVelocitySolver::nDoF().

◆ m_RelaxRelTol

Real JFNKSolver::Configuration::m_RelaxRelTol

Relax solver relative tolerance.

◆ m_relTol

Real JFNKSolver::Configuration::m_relTol

relative tolerance for convergence test;

◆ m_residualOnly

bool JFNKSolver::Configuration::m_residualOnly

◆ m_scale

Real JFNKSolver::Configuration::m_scale

◆ m_switchRate

Real JFNKSolver::Configuration::m_switchRate

rate at which to switch from Picard to JFNK mode

◆ m_umin

Real JFNKSolver::Configuration::m_umin

parameter that appears in the adaptive calculation of h

◆ m_verbosity

int JFNKSolver::Configuration::m_verbosity

verbosity

◆ m_vtopRelaxMinIter

int JFNKSolver::Configuration::m_vtopRelaxMinIter

minimum number of smnooths in viscous tensor op mg relax

◆ m_vtopRelaxTol

Real JFNKSolver::Configuration::m_vtopRelaxTol

relax tolerance for viscous tensor op

◆ m_vtopSafety

Real JFNKSolver::Configuration::m_vtopSafety

safety number for viscous tensor op

◆ m_writeResiduals

bool JFNKSolver::Configuration::m_writeResiduals

write out residual data frequently: useful for working out why solves fail

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Public Attributes