amrex::HypreMLABecLap Class Reference

Multilevel HYPRE solver that mirrors MLMG's ABecLaplacian structure. More...

#include <AMReX_HypreMLABecLap.H>

Public Member Functions
	HypreMLABecLap (HypreMLABecLap const &)=delete
	HypreMLABecLap (HypreMLABecLap &&)=delete
HypreMLABecLap &	operator= (HypreMLABecLap const &)=delete
HypreMLABecLap &	operator= (HypreMLABecLap &&)=delete
	HypreMLABecLap (Vector< Geometry > a_geom, Vector< BoxArray > a_grids, Vector< DistributionMapping > a_dmap, HypreSolverID a_hypre_solver_id, std::string a_parmparse_prefix="hypre_mlabeclap")
	Construct the multilevel HYPRE wrapper and copy the hierarchy metadata.
	~HypreMLABecLap ()
void	setVerbose (int v)
	Set HYPRE's logging verbosity (v).
void	setMaxIter (int v)
	Override the maximum number of HYPRE iterations (v).
void	setIsSingular (bool v)
	Flag whether the assembled operator is singular (v).
void	setReuseSolverSetup (bool v)
	IJ mode only: let setup() be called again with new coefficients (same grids), updating the matrix values in place and keeping the solver/preconditioner setup, which then only approximates the new operator (see resetSolverSetup()).
void	resetSolverSetup ()
	IJ mode only: redo the solver/preconditioner setup at the next solve.
void	setThrowException (bool t) noexcept
	Throw std::runtime_error instead of aborting when the solve fails.
int	getNumIters () const noexcept
	Iterations and final relative residual of the last solve.
Real	getFinalResidualNorm () const noexcept
void	setup (Real a_ascalar, Real a_bscalar, Vector< MultiFab const * > const &a_acoefs, Vector< Array< MultiFab const *, 3 > > const &a_bcoefs, Array< LinOpBCType, 3 > const &a_lobc, Array< LinOpBCType, 3 > const &a_hibc, Vector< MultiFab const * > const &a_levelbcdata, std::pair< MultiFab const *, IntVect > const &a_coarse_bc={nullptr, IntVect(0)})
	Assemble the HYPRE operators/storage for the provided coefficients.
void	solve (Vector< MultiFab * > const &a_sol, Vector< MultiFab const * > const &a_rhs, Real a_reltol, Real a_abstol)
	Solve the assembled system with HYPRE (single-component).
void	commBCoefs (int flev, Array< MultiFab const *, 3 > const &a_bcoefs)
	Communicate b coefficients needed by level flev at coarse/fine interfaces.
void	commBCoefs_local (int flev, Array< MultiFab const *, 3 > const &a_bcoefs, Vector< FabArrayBase::CopyComTag > const &tags)
	Local portion of commBCoefs used to issue device-friendly copies.
void	buildIJMaps ()
	Build the device maps of the IJ assembly; public for cuda.
void	solveIJ (Vector< MultiFab * > const &a_sol, Vector< MultiFab const * > const &a_rhs, Real a_reltol, Real a_abstol)
	Solve with the IJ system (see m_use_ij); public for cuda.

Detailed Description

Multilevel HYPRE solver that mirrors MLMG's ABecLaplacian structure.

Constructor & Destructor Documentation

HypreMLABecLap() [1/3]

amrex::HypreMLABecLap::HypreMLABecLap ( HypreMLABecLap const & )

delete

HypreMLABecLap() [2/3]

amrex::HypreMLABecLap::HypreMLABecLap ( HypreMLABecLap && )

delete

HypreMLABecLap() [3/3]

amrex::HypreMLABecLap::HypreMLABecLap	(	Vector< Geometry >	a_geom,
		Vector< BoxArray >	a_grids,
		Vector< DistributionMapping >	a_dmap,
		HypreSolverID	a_hypre_solver_id,
		std::string	a_parmparse_prefix = "hypre_mlabeclap" )

Construct the multilevel HYPRE wrapper and copy the hierarchy metadata.

Parameters

a_geom	Per-level geometries (fine to coarse).
a_grids	Per-level BoxArrays.
a_dmap	Per-level DistributionMappings.
a_hypre_solver_id	Solver type (BoomerAMG or SSAMG).
a_parmparse_prefix	ParmParse prefix for runtime options.

~HypreMLABecLap()

amrex::HypreMLABecLap::~HypreMLABecLap

(

)

Member Function Documentation

buildIJMaps()

void amrex::HypreMLABecLap::buildIJMaps

(

)

Build the device maps of the IJ assembly; public for cuda.

commBCoefs()

void amrex::HypreMLABecLap::commBCoefs	(	int	flev,
		Array< MultiFab const *, 3 > const &	a_bcoefs )

Communicate b coefficients needed by level flev at coarse/fine interfaces.

Parameters

flev	Finest AMR level whose coarse/fine stencils are being prepared.
a_bcoefs	Face-centered coefficients for that level (per direction).

commBCoefs_local()

void amrex::HypreMLABecLap::commBCoefs_local	(	int	flev,
		Array< MultiFab const *, 3 > const &	a_bcoefs,
		Vector< FabArrayBase::CopyComTag > const &	tags )

Local portion of commBCoefs used to issue device-friendly copies.

Parameters

flev	AMR level whose coarse/fine data are exchanged.
a_bcoefs	Face arrays for that level.
tags	Cached copy tags extracted from FabArray communications.

getFinalResidualNorm()

Real amrex::HypreMLABecLap::getFinalResidualNorm ( ) const

inlinenodiscardnoexcept

getNumIters()

int amrex::HypreMLABecLap::getNumIters ( ) const

inlinenodiscardnoexcept

Iterations and final relative residual of the last solve.

operator=() [1/2]

HypreMLABecLap & amrex::HypreMLABecLap::operator= ( HypreMLABecLap && )

delete

operator=() [2/2]

HypreMLABecLap & amrex::HypreMLABecLap::operator= ( HypreMLABecLap const & )

delete

resetSolverSetup()

void amrex::HypreMLABecLap::resetSolverSetup ( )

inline

IJ mode only: redo the solver/preconditioner setup at the next solve.

setIsSingular()

void amrex::HypreMLABecLap::setIsSingular ( bool v )

inline

Flag whether the assembled operator is singular (v).

setMaxIter()

void amrex::HypreMLABecLap::setMaxIter ( int v )

inline

Override the maximum number of HYPRE iterations (v).

setReuseSolverSetup()

void amrex::HypreMLABecLap::setReuseSolverSetup ( bool v )

inline

IJ mode only: let setup() be called again with new coefficients (same grids), updating the matrix values in place and keeping the solver/preconditioner setup, which then only approximates the new operator (see resetSolverSetup()).

setThrowException()

void amrex::HypreMLABecLap::setThrowException ( bool t )

inlinenoexcept

Throw std::runtime_error instead of aborting when the solve fails.

setup()

void amrex::HypreMLABecLap::setup	(	Real	a_ascalar,
		Real	a_bscalar,
		Vector< MultiFab const * > const &	a_acoefs,
		Vector< Array< MultiFab const *, 3 > > const &	a_bcoefs,
		Array< LinOpBCType, 3 > const &	a_lobc,
		Array< LinOpBCType, 3 > const &	a_hibc,
		Vector< MultiFab const * > const &	a_levelbcdata,
		std::pair< MultiFab const *, IntVect > const &	a_coarse_bc = {nullptr, IntVect(0)} )

Assemble the HYPRE operators/storage for the provided coefficients.

Parameters

a_ascalar	Scalar applied to the diagonal term.
a_bscalar	Scalar applied to the diffusive term.
a_acoefs	Level-by-level a coefficients.
a_bcoefs	Level-by-level arrays of face-centered b coefficients.
a_lobc	Low-side boundary-condition types.
a_hibc	High-side boundary-condition types.
a_levelbcdata	BC data per level; a missing or null entry means zero.
a_coarse_bc	Optional BC data from even coarser AMR level.

setVerbose()

void amrex::HypreMLABecLap::setVerbose ( int v )

inline

Set HYPRE's logging verbosity (v).

solve()

void amrex::HypreMLABecLap::solve	(	Vector< MultiFab * > const &	a_sol,
		Vector< MultiFab const * > const &	a_rhs,
		Real	a_reltol,
		Real	a_abstol )

Solve the assembled system with HYPRE (single-component).

Parameters

a_sol	Vector of level solution MultiFabs (filled on return).
a_rhs	Vector of level right-hand sides.
a_reltol	Relative tolerance.
a_abstol	Absolute tolerance.

solveIJ()

void amrex::HypreMLABecLap::solveIJ	(	Vector< MultiFab * > const &	a_sol,
		Vector< MultiFab const * > const &	a_rhs,
		Real	a_reltol,
		Real	a_abstol )

Solve with the IJ system (see m_use_ij); public for cuda.

---

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

• /home/runner/work/amrex/amrex/Src/Extern/HYPRE/AMReX_HypreMLABecLap.H
• /home/runner/work/amrex/amrex/Src/Extern/HYPRE/AMReX_HypreMLABecLap.cpp