#include <Newton.H>

Inheritance diagram for Solver::Nonlocal::Newton< T >:

Public Member Functions
	Newton ()

	Newton (Operator::Elastic< T::sym > &a_op)

	~Newton ()

void	Define (Operator::Elastic< T::sym > &a_op)

void	Clear ()

void	setNRIters (int a_nriters)

void	setPsi (Set::Field< Set::Scalar > &a_psi)

bool	usesConservativeFaceFlux () const

Set::Scalar	solve (const Set::Field< Set::Vector > &a_u_mf, const Set::Field< Set::Vector > &a_b_mf, Set::Field< T > &a_model_mf, Real a_tol_rel, Real a_tol_abs, const char *checkpoint_file=nullptr)

Set::Scalar	solve (const Set::Field< Set::Scalar > &a_u_mf, const Set::Field< Set::Scalar > &a_b_mf, Set::Field< T > &a_model_mf, Real a_tol_rel, Real a_tol_abs, const char *checkpoint_file=nullptr)

Set::Scalar	solve (const Set::Field< Set::Scalar > &a_u_mf, const Set::Field< Set::Scalar > &a_b_mf, Set::Field< T > &a_model_mf)

void	compResidual (Set::Field< Set::Scalar > &a_res_mf, Set::Field< Set::Scalar > &a_u_mf, Set::Field< Set::Scalar > &a_b_mf, Set::Field< T > &a_model_mf)

void	compResidual (Set::Field< Set::Vector > &a_res_mf, Set::Field< Set::Vector > &a_u_mf, Set::Field< Set::Vector > &a_b_mf, Set::Field< T > &a_model_mf)

void	compLinearSolverResidual (Set::Field< Set::Vector > &a_res_mf, Set::Field< Set::Vector > &a_u_mf, Set::Field< Set::Vector > &a_b_mf)

void	W (Set::Field< Set::Scalar > &a_w_mf, Set::Field< Set::Scalar > &a_u_mf, Set::Field< T > &a_model_mf)

void	DW (Set::Field< Set::Scalar > &a_dw_mf, Set::Field< Set::Scalar > &a_u_mf, Set::Field< T > &a_model_mf)

Public Member Functions inherited from Solver::Nonlocal::Linear
	Linear ()

	Linear (Operator::Operator< Grid::Node > &a_lp)

	~Linear ()

void	Define (Operator::Operator< Grid::Node > &a_lp)

void	Clear ()

Set::Scalar	solveaffine (amrex::Vector< std::unique_ptr< amrex::MultiFab > > &a_sol, amrex::Vector< std::unique_ptr< amrex::MultiFab > > &a_rhs, Real a_tol_rel, Real a_tol_abs, bool copyrhs=false, const char *checkpoint_file=nullptr)

Set::Scalar	solve (amrex::Vector< std::unique_ptr< amrex::MultiFab > > &a_sol, amrex::Vector< std::unique_ptr< amrex::MultiFab > > &a_rhs, Real a_tol_rel, Real a_tol_abs, const char *checkpoint_file=nullptr)

Set::Scalar	solve (amrex::Vector< std::unique_ptr< amrex::MultiFab > > &a_sol, amrex::Vector< std::unique_ptr< amrex::MultiFab > > &a_rhs)

void	apply (amrex::Vector< std::unique_ptr< amrex::MultiFab > > &a_rhs, amrex::Vector< std::unique_ptr< amrex::MultiFab > > &a_sol)

void	setMaxIter (const int a_max_iter)

void	setBottomMaxIter (const int a_bottom_max_iter)

void	setMaxFmgIter (const int a_max_fmg_iter)

void	setFixedIter (const int a_fixed_iter)

void	setVerbose (const int a_verbose)

void	setPreSmooth (const int a_pre_smooth)

void	setPostSmooth (const int a_post_smooth)

void	dumpOnConvergenceFail (const amrex::Vector< amrex::MultiFab * > &a_sol_mf, const amrex::Vector< amrex::MultiFab const * > &a_rhs_mf)

Static Public Member Functions
static void	Parse (Newton< T > &value, amrex::ParmParse &pp)

Static Public Member Functions inherited from Solver::Nonlocal::Linear
static void	Parse (Linear &value, amrex::ParmParse &pp)

Data Fields
int	m_nriters = 1

Set::Scalar	m_nrtolerance = 0.0

bool	m_line_search = false

bool	m_resync_coeffs = false

bool	m_nr_abort_on_fail = false

Operator::Elastic< T::sym > *	m_elastic

Set::Field< Set::Scalar > *	m_psi = nullptr

bool	m_conservative_face_flux = false

Private Member Functions
void	prepareForSolve (const Set::Field< Set::Scalar > &a_u_mf, const Set::Field< Set::Scalar > &a_b_mf, Set::Field< Set::Scalar > &a_rhs_mf, Set::Field< Set::Matrix > &a_dw_mf, Set::Field< Set::Matrix4< AMREX_SPACEDIM, T::sym > > &a_ddw_mf, Set::Field< T > &a_model_mf)

void	prepareForSolve (const Set::Field< Set::Vector > &a_u_mf, const Set::Field< Set::Vector > &a_b_mf, Set::Field< Set::Scalar > &a_rhs_mf, Set::Field< Set::Matrix > &a_dw_mf, Set::Field< Set::Matrix4< AMREX_SPACEDIM, T::sym > > &a_ddw_mf, Set::Field< T > &a_model_mf)

Set::Scalar	FieldNorm0 (const Set::Field< Set::Scalar > &a_mf) const

Private Attributes
bool	m_reported_psi_face_flux_conflict = false

Additional Inherited Members
Protected Member Functions inherited from Solver::Nonlocal::Linear
void	PrepareMLMG (amrex::MLMG &mlmg)

Protected Attributes inherited from Solver::Nonlocal::Linear
int	max_iter = -1

int	bottom_max_iter = -1

int	max_fmg_iter = -1

int	fixed_iter = -1

int	verbose = -1

int	pre_smooth = -1

int	post_smooth = -1

int	final_smooth = -1

int	bottom_smooth = -1

std::string	bottom_solver

Set::Scalar	cg_tol_rel = -1.0

Set::Scalar	cg_tol_abs = -1.0

Set::Scalar	bottom_tol_rel = -1.0

Set::Scalar	bottom_tol_abs = -1.0

Set::Scalar	tol_rel = -1.0

Set::Scalar	tol_abs = -1.0

Set::Scalar	omega = -1.0

bool	average_down_coeffs = false

bool	normalize_ddw = false

Operator::Operator< Grid::Node > *	linop

amrex::MLMG *	mlmg

bool	m_defined = false

bool	m_dump_on_fail = false

bool	m_abort_on_fail = true

Detailed Description

template<typename T>
class Solver::Nonlocal::Newton< T >

Definition at line 93 of file Newton.H.

Constructor & Destructor Documentation

◆ Newton() [1/2]

template<typename T >

Solver::Nonlocal::Newton< T >::Newton ( )

inline

Definition at line 96 of file Newton.H.

◆ Newton() [2/2]

template<typename T >

Solver::Nonlocal::Newton< T >::Newton ( Operator::Elastic< T::sym > & a_op )

inline

Definition at line 98 of file Newton.H.

◆ ~Newton()

template<typename T >

Solver::Nonlocal::Newton< T >::~Newton ( )

inline

Definition at line 103 of file Newton.H.

Member Function Documentation

◆ Clear()

template<typename T >

void Solver::Nonlocal::Newton< T >::Clear ( )

inline

Definition at line 114 of file Newton.H.

◆ compLinearSolverResidual()

template<typename T >

void Solver::Nonlocal::Newton< T >::compLinearSolverResidual	(	Set::Field< Set::Vector > &	a_res_mf,
		Set::Field< Set::Vector > &	a_u_mf,
		Set::Field< Set::Vector > &	a_b_mf
	)

inline

Definition at line 776 of file Newton.H.

◆ compResidual() [1/2]

template<typename T >

void Solver::Nonlocal::Newton< T >::compResidual	(	Set::Field< Set::Scalar > &	a_res_mf,
		Set::Field< Set::Scalar > &	a_u_mf,
		Set::Field< Set::Scalar > &	a_b_mf,
		Set::Field< T > &	a_model_mf
	)

inline

Definition at line 713 of file Newton.H.

◆ compResidual() [2/2]

template<typename T >

void Solver::Nonlocal::Newton< T >::compResidual	(	Set::Field< Set::Vector > &	a_res_mf,
		Set::Field< Set::Vector > &	a_u_mf,
		Set::Field< Set::Vector > &	a_b_mf,
		Set::Field< T > &	a_model_mf
	)

inline

Definition at line 736 of file Newton.H.

◆ Define()

template<typename T >

void Solver::Nonlocal::Newton< T >::Define ( Operator::Elastic< T::sym > & a_op )

inline

Definition at line 108 of file Newton.H.

◆ DW()

template<typename T >

void Solver::Nonlocal::Newton< T >::DW	(	Set::Field< Set::Scalar > &	a_dw_mf,
		Set::Field< Set::Scalar > &	a_u_mf,
		Set::Field< T > &	a_model_mf
	)

inline

Definition at line 845 of file Newton.H.

◆ FieldNorm0()

template<typename T >

Set::Scalar Solver::Nonlocal::Newton< T >::FieldNorm0 ( const Set::Field< Set::Scalar > & a_mf ) const

inlineprivate

Definition at line 918 of file Newton.H.

◆ Parse()

template<typename T >

static void Solver::Nonlocal::Newton< T >::Parse	(	Newton< T > &	value,
		amrex::ParmParse &	pp
	)

inlinestatic

Definition at line 951 of file Newton.H.

◆ prepareForSolve() [1/2]

template<typename T >

void Solver::Nonlocal::Newton< T >::prepareForSolve	(	const Set::Field< Set::Scalar > &	a_u_mf,
		const Set::Field< Set::Scalar > &	a_b_mf,
		Set::Field< Set::Scalar > &	a_rhs_mf,
		Set::Field< Set::Matrix > &	a_dw_mf,
		Set::Field< Set::Matrix4< AMREX_SPACEDIM, T::sym > > &	a_ddw_mf,
		Set::Field< T > &	a_model_mf
	)

inlineprivate

Definition at line 140 of file Newton.H.

◆ prepareForSolve() [2/2]

template<typename T >

void Solver::Nonlocal::Newton< T >::prepareForSolve	(	const Set::Field< Set::Vector > &	a_u_mf,
		const Set::Field< Set::Vector > &	a_b_mf,
		Set::Field< Set::Scalar > &	a_rhs_mf,
		Set::Field< Set::Matrix > &	a_dw_mf,
		Set::Field< Set::Matrix4< AMREX_SPACEDIM, T::sym > > &	a_ddw_mf,
		Set::Field< T > &	a_model_mf
	)

inlineprivate

Definition at line 232 of file Newton.H.

◆ setNRIters()

template<typename T >

void Solver::Nonlocal::Newton< T >::setNRIters ( int a_nriters )

inline

Definition at line 122 of file Newton.H.

◆ setPsi()

template<typename T >

void Solver::Nonlocal::Newton< T >::setPsi ( Set::Field< Set::Scalar > & a_psi )

inline

Definition at line 124 of file Newton.H.

◆ solve() [1/3]

template<typename T >

Set::Scalar Solver::Nonlocal::Newton< T >::solve	(	const Set::Field< Set::Scalar > &	a_u_mf,
		const Set::Field< Set::Scalar > &	a_b_mf,
		Set::Field< T > &	a_model_mf
	)

inline

Definition at line 706 of file Newton.H.

◆ solve() [2/3]

template<typename T >

Set::Scalar Solver::Nonlocal::Newton< T >::solve	(	const Set::Field< Set::Scalar > &	a_u_mf,
		const Set::Field< Set::Scalar > &	a_b_mf,
		Set::Field< T > &	a_model_mf,
		Real	a_tol_rel,
		Real	a_tol_abs,
		const char *	checkpoint_file = `nullptr`
	)

inline

Definition at line 628 of file Newton.H.

◆ solve() [3/3]

template<typename T >

Set::Scalar Solver::Nonlocal::Newton< T >::solve	(	const Set::Field< Set::Vector > &	a_u_mf,
		const Set::Field< Set::Vector > &	a_b_mf,
		Set::Field< T > &	a_model_mf,
		Real	a_tol_rel,
		Real	a_tol_abs,
		const char *	checkpoint_file = `nullptr`
	)

inline

Definition at line 438 of file Newton.H.

◆ usesConservativeFaceFlux()

template<typename T >

bool Solver::Nonlocal::Newton< T >::usesConservativeFaceFlux ( ) const

inline

Definition at line 134 of file Newton.H.

◆ W()

template<typename T >

void Solver::Nonlocal::Newton< T >::W	(	Set::Field< Set::Scalar > &	a_w_mf,
		Set::Field< Set::Scalar > &	a_u_mf,
		Set::Field< T > &	a_model_mf
	)

inline

Definition at line 802 of file Newton.H.

Field Documentation

◆ m_conservative_face_flux

template<typename T >

bool Solver::Nonlocal::Newton< T >::m_conservative_face_flux = false

Definition at line 913 of file Newton.H.

◆ m_elastic

template<typename T >

Operator::Elastic<T::sym>* Solver::Nonlocal::Newton< T >::m_elastic

Definition at line 909 of file Newton.H.

◆ m_line_search

template<typename T >

bool Solver::Nonlocal::Newton< T >::m_line_search = false

Definition at line 906 of file Newton.H.

◆ m_nr_abort_on_fail

template<typename T >

bool Solver::Nonlocal::Newton< T >::m_nr_abort_on_fail = false

Definition at line 908 of file Newton.H.

◆ m_nriters

template<typename T >

int Solver::Nonlocal::Newton< T >::m_nriters = 1

Definition at line 904 of file Newton.H.

◆ m_nrtolerance

template<typename T >

Set::Scalar Solver::Nonlocal::Newton< T >::m_nrtolerance = 0.0

Definition at line 905 of file Newton.H.

◆ m_psi

template<typename T >

Set::Field<Set::Scalar>* Solver::Nonlocal::Newton< T >::m_psi = nullptr

Definition at line 912 of file Newton.H.

◆ m_reported_psi_face_flux_conflict

template<typename T >

bool Solver::Nonlocal::Newton< T >::m_reported_psi_face_flux_conflict = false

private

Definition at line 916 of file Newton.H.

◆ m_resync_coeffs

template<typename T >

bool Solver::Nonlocal::Newton< T >::m_resync_coeffs = false

Definition at line 907 of file Newton.H.

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

src/Solver/Nonlocal/Newton.H

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Newton() [1/2]

◆ Newton() [2/2]

◆ ~Newton()

Member Function Documentation

◆ Clear()

◆ compLinearSolverResidual()

◆ compResidual() [1/2]

◆ compResidual() [2/2]

◆ Define()

◆ DW()

◆ FieldNorm0()

◆ Parse()

◆ prepareForSolve() [1/2]

◆ prepareForSolve() [2/2]

◆ setNRIters()

◆ setPsi()

◆ solve() [1/3]

◆ solve() [2/3]

◆ solve() [3/3]

◆ usesConservativeFaceFlux()

◆ W()

Field Documentation

◆ m_conservative_face_flux

◆ m_elastic

◆ m_line_search

◆ m_nr_abort_on_fail

◆ m_nriters

◆ m_nrtolerance

◆ m_psi

◆ m_reported_psi_face_flux_conflict

◆ m_resync_coeffs