#include <AMReX_MLNodeTensorLaplacian.H>

Inheritance diagram for amrex::MLNodeTensorLaplacian:

Public Member Functions
	MLNodeTensorLaplacian ()=default
	MLNodeTensorLaplacian (const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const LPInfo &a_info=LPInfo())
	~MLNodeTensorLaplacian () override=default
	MLNodeTensorLaplacian (const MLNodeTensorLaplacian &)=delete
	MLNodeTensorLaplacian (MLNodeTensorLaplacian &&)=delete
MLNodeTensorLaplacian &	operator= (const MLNodeTensorLaplacian &)=delete
MLNodeTensorLaplacian &	operator= (MLNodeTensorLaplacian &&)=delete
void	setSigma (Array< Real, nelems > const &a_sigma) noexcept
	Configure the symmetric tensor sigma.
void	setBeta (Array< Real, 3 > const &a_beta) noexcept
	Convenience helper that sets sigma = I - beta beta^T.
void	define (const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const LPInfo &a_info=LPInfo())
	Bind the tensor operator to the AMR hierarchy (no EB support).
std::string	name () const override
void	restriction (int amrlev, int cmglev, MultiFab &crse, MultiFab &fine) const final
	Restrict nodal tensor data from fine to coarse on AMR level `amrlev` / MG level `cmglev`.
void	interpolation (int amrlev, int fmglev, MultiFab &fine, const MultiFab &crse) const final
	Add the prolongation of coarse data onto the fine grid (`fine` += prolong(`crse`)).
void	averageDownSolutionRHS (int camrlev, MultiFab &crse_sol, MultiFab &crse_rhs, const MultiFab &fine_sol, const MultiFab &fine_rhs) final
	Average fine AMR data (`fine_sol`, `fine_rhs`) into coarse arrays (`crse_sol`, `crse_rhs`) on level `camrlev`.
void	reflux (int crse_amrlev, MultiFab &res, const MultiFab &crse_sol, const MultiFab &crse_rhs, MultiFab &fine_res, MultiFab &fine_sol, const MultiFab &fine_rhs) const final
	Flux-register reflux between coarse/fine tensor solves; updates `res` and `fine_res` using solutions and RHS on AMR index `crse_amrlev`.
void	smooth (int amrlev, int mglev, MultiFab &sol, const MultiFab &rhs, bool skip_fillboundary, int niter) const final
	Tensor-aware smoother override for nodal data (updates `sol` against `rhs` for `niter` passes; set `skip_fillboundary` when ghosts are valid).
void	prepareForSolve () final
	Finalize tensor coefficients and BC caches before solving.
void	Fapply (int amrlev, int mglev, MultiFab &out, const MultiFab &in) const final
	Apply the tensor Laplacian to `in` at (`amrlev`,`mglev`).
void	Fsmooth (int amrlev, int mglev, MultiFab &sol, const MultiFab &rhs) const final
	Execute the nodal tensor smoother on (`amrlev`,`mglev`).
void	normalize (int amrlev, int mglev, MultiFab &mf) const final
	Divide `mf` by the diagonal of the operator (used by CG-family bottom solvers).
void	fixUpResidualMask (int amrlev, iMultiFab &resmsk) final
	Adjust residual masks `resmsk` so tensor Dirichlet EB nodes remain fixed.
bool	supportsAlgMG () const override
	True if makeAlgMG is implemented for this operator.
bool	needsUpdate () const final
	True after setSigma or setBeta, so that cached matrices are rebuilt.
void	update () final
	Update for reuse.
void	fillAlgMatrix (int mglev, MFIter const &mfi, Array4< Long const > const &gid, Array4< int const > const &lid, Long ncols, Long cols, Real *mat) const override
	Fill the matrix rows of one box for the algebraic solver.
void	fillRHS (int mglev, MFIter const &mfi, Array4< int const > const &lid, Real *rhs, Array4< Real const > const &bfab) const override
	Fill the RHS vector for nodal tensor solves.
template<typename AlgInt, typename AlgGid>
void	fillMatrix_doit (int mglev, MFIter const &mfi, Array4< AlgGid const > const &gid, Array4< int const > const &lid, AlgInt ncols, AlgInt cols, Real *mat) const
Public Member Functions inherited from amrex::MLNodeLinOp
	MLNodeLinOp ()
	~MLNodeLinOp () override=default
	MLNodeLinOp (const MLNodeLinOp &)=delete
	MLNodeLinOp (MLNodeLinOp &&)=delete
MLNodeLinOp &	operator= (const MLNodeLinOp &)=delete
MLNodeLinOp &	operator= (MLNodeLinOp &&)=delete
void	define (const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const LPInfo &a_info=LPInfo(), const Vector< FabFactory< FArrayBox > const * > &a_factory={}, int a_eb_limit_coarsening=-1)
	Bind the nodal operator to an AMR hierarchy.
void	setSmoothNumSweeps (int nsweeps) noexcept
	Control how many smoother passes are executed inside each Fsmooth call.
void	setLevelBC (int, const MultiFab , const MultiFab =nullptr, const MultiFab =nullptr, const MultiFab =nullptr) final
	Set boundary conditions for given level. For cell-centered solves only.
void	apply (int amrlev, int mglev, MultiFab &out, MultiFab &in, BCMode bc_mode, StateMode s_mode, const MLMGBndry *bndry=nullptr) const final
	Apply the nodal operator with the requested BC/state modes.
void	solutionResidual (int amrlev, MultiFab &resid, MultiFab &x, const MultiFab &b, const MultiFab *crse_bcdata=nullptr) override
	Residual helper that uses solution BCs and optional coarse data (operates on AMR level `amrlev`).
void	correctionResidual (int amrlev, int mglev, MultiFab &resid, MultiFab &x, const MultiFab &b, BCMode bc_mode, const MultiFab *crse_bcdata=nullptr) override
	Residual helper for correction solves (optionally homogeneous BCs) on (`amrlev`,`mglev`).
Vector< Real >	getSolvabilityOffset (int amrlev, int mglev, MultiFab const &rhs) const override
	Return component-wise solvability offsets for (`amrlev`,`mglev`, `rhs`).
void	fixSolvabilityByOffset (int amrlev, int mglev, MultiFab &rhs, Vector< Real > const &offset) const override
	Subtract offsets produced by getSolvabilityOffset() from `rhs`.
void	preparePrecond () override
	Prepare auxiliary data used when the operator acts as a preconditioner.
void	setDirichletNodesToZero (int amrlev, int mglev, MultiFab &mf) const override
	Zero Dirichlet nodes in `mf` before a correction or residual pass.
bool	isSingular (int amrlev) const override
	Is it singular on AMR level `amrlev`?
bool	isBottomSingular () const override
	Is the bottom of the multigrid hierarchy singular?
Real	xdoty (int amrlev, int mglev, const MultiFab &x, const MultiFab &y, bool local) const final
	Dot-product helper.
Real	dotProductPrecond (Vector< MultiFab const * > const &x, Vector< MultiFab const * > const &y) const final
	Dot product used when the operator acts as a preconditioner.
Real	norm2Precond (Vector< MultiFab const * > const &x) const final
	L2 norm used when the operator acts as a preconditioner.
virtual void	applyBC (int amrlev, int mglev, MultiFab &phi, BCMode bc_mode, StateMode state_mode, bool skip_fillboundary=false) const
	Apply physical BCs prior to smoothing/apply.
void	nodalSync (int amrlev, int mglev, MultiFab &mf) const
	Synchronize nodal values across box/partition boundaries on (`amrlev`,`mglev`).
void	buildMasks ()
	Build Dirichlet/dot-product masks and determine bottom singularity.
void	setOversetMask (int amrlev, const iMultiFab &a_dmask)
	Mark nodes that belong to overset (known) regions.
Real	normInf (int amrlev, MultiFab const &mf, bool local) const override
	Infinity norm helper operating on level `amrlev` (set `local` to true to skip MPI reduction).
void	avgDownResAmr (int, MultiFab &, MultiFab const &) const final
	Nodal average-down for residuals between AMR levels (no-op here).
void	interpolationAmr (int famrlev, MultiFab &fine, const MultiFab &crse, IntVect const &nghost) const override
	Prolong AMR-level data during FMG initialization.
void	averageDownAndSync (Vector< MultiFab > &sol) const override
	Average nodal solutions down the AMR hierarchy and synchronize overlaps.
void	interpAssign (int amrlev, int fmglev, MultiFab &fine, MultiFab &crse) const override
	Overwrite fine data with the prolongation of coarse data (`fine` = prolong(`crse`)).
std::unique_ptr< MLAlgMG >	makeAlgMG (int mglev) const override
	Build the algebraic system of MG level `mglev` of AMR level 0 for the AlgMG solver. Operators that hypre supports implement this.
Public Member Functions inherited from amrex::MLLinOpT< MultiFab >
	MLLinOpT ()=default
virtual	~MLLinOpT ()=default
	MLLinOpT (const MLLinOpT< MultiFab > &)=delete
	MLLinOpT (MLLinOpT< MultiFab > &&)=delete
MLLinOpT< MultiFab > &	operator= (const MLLinOpT< MultiFab > &)=delete
MLLinOpT< MultiFab > &	operator= (MLLinOpT< MultiFab > &&)=delete
void	define (const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const LPInfo &a_info, const Vector< FabFactory< FAB > const * > &a_factory, bool eb_limit_coarsening=true)
	Initialize the operator hierarchy on a set of AMR levels.
void	setDomainBC (const Array< BCType, 3 > &lobc, const Array< BCType, 3 > &hibc) noexcept
	Boundary of the whole domain.
void	setDomainBC (const Vector< Array< BCType, 3 > > &lobc, const Vector< Array< BCType, 3 > > &hibc)
	Boundary of the whole domain.
void	setDomainBCLoc (const Array< Real, 3 > &lo_bcloc, const Array< Real, 3 > &hi_bcloc) noexcept
	Set location offsets for the physical domain boundaries.
bool	needsCoarseDataForBC () const noexcept
	Needs coarse data for bc?
void	setCoarseFineBC (const MultiFab *crse, int crse_ratio, LinOpBCType bc_type=LinOpBCType::Dirichlet) noexcept
	Set coarse/fine boundary conditions. For cell-centered solves only.
void	setCoarseFineBC (const MultiFab *crse, IntVect const &crse_ratio, LinOpBCType bc_type=LinOpBCType::Dirichlet) noexcept
void	setCoarseFineBC (const AMF *crse, int crse_ratio, LinOpBCType bc_type=LinOpBCType::Dirichlet) noexcept
void	setCoarseFineBC (const AMF *crse, IntVect const &crse_ratio, LinOpBCType bc_type=LinOpBCType::Dirichlet) noexcept
void	setLevelBC (int amrlev, const AMF levelbcdata, const AMF robinbc_a=nullptr, const AMF robinbc_b=nullptr, const AMF robinbc_f=nullptr)
void	setVerbose (int v) noexcept
	Set verbosity.
void	setPrintIndentation (std::string s)
	Prefix printed messages (e.g., to indent per level).
void	setMaxOrder (int o) noexcept
	Set order of interpolation at coarse/fine boundary.
int	getMaxOrder () const noexcept
	Get order of interpolation at coarse/fine boundary.
void	setEnforceSingularSolvable (bool o) noexcept
	Control whether the solver should try to make singular problems solvable.
bool	getEnforceSingularSolvable () const noexcept
virtual BottomSolver	getDefaultBottomSolver () const
virtual bool	supportCustomBottomSolver () const
	Does this operator provide its own bottom solver (BottomSolver::custom)?
virtual void	customBottomSolve (MLMGT< MultiFab > *mlmg, MultiFab &x, const MultiFab &b, RT eps_rel, RT eps_abs, int maxiter)
	Bottom solve provided by the operator itself.
virtual int	getNComp () const
	Return number of components.
virtual int	getNGrow (int=0, int=0) const
virtual void	interpCoarseFineSolution (int famrlev, MultiFab &fine_sol, const MultiFab &crse_sol) const
	Before a composite solve, set the solution at the nodes that fine AMR level famrlev takes from the coarse level (the coarse/fine nodes of MLNodeLaplacian) to the interpolated coarse solution. The solve only adds interpolated corrections there, so the result would otherwise depend on the initial guess. The default does nothing.
virtual void	apply (int amrlev, int mglev, MultiFab &out, MultiFab &in, BCMode bc_mode, StateMode s_mode, const MLMGBndryT< MultiFab > *bndry=nullptr) const=0
	Apply the linear operator, out = L(in).
virtual void	prepareForFluxes (int amrlev, const MultiFab *crse_bcdata=nullptr)
	Ensure BC caches are populated before flux extraction.
virtual void	correctionResidual (int amrlev, int mglev, MultiFab &resid, MultiFab &x, const MultiFab &b, BCMode bc_mode, const MultiFab *crse_bcdata=nullptr)=0
	Compute residual for the residual-correction form, resid = b - L(x).
virtual void	compFlux (int amrlev, const Array< MultiFab *, 3 > &fluxes, MultiFab &sol, Location loc) const
	Compute fluxes.
virtual void	compGrad (int amrlev, const Array< MultiFab *, 3 > &grad, MultiFab &sol, Location loc) const
	Compute gradients of the solution.
virtual void	applyMetricTerm (int amrlev, int mglev, MultiFab &rhs) const
	Apply metric scaling to the RHS on (`amrlev`,`mglev`).
virtual void	unapplyMetricTerm (int amrlev, int mglev, MultiFab &rhs) const
	Remove metric scaling previously applied via applyMetricTerm().
virtual void	unimposeNeumannBC (int amrlev, MultiFab &rhs) const
	Undo Neumann contributions stored on the RHS.
virtual void	applyInhomogNeumannTerm (int amrlev, MultiFab &rhs) const
	Add extra terms introduced when treating inhomogeneous Neumann BC as homogeneous.
virtual void	applyOverset (int amrlev, MultiFab &rhs) const
	Overset-only hook for zeroing regions covered by masks.
virtual bool	scaleRHS (int amrlev, MultiFab *rhs) const
	Optionally scale the RHS to fix solvability.
virtual void	fixSolvabilityByOffset (int amrlev, int mglev, MultiFab &rhs, Vector< RT > const &offset) const
	Subtract previously computed offsets from the RHS.
virtual std::unique_ptr< MLLinOpT< MultiFab > >	makeNLinOp (int grid_size) const
	Create the NSolve counterpart of this operator with the requested grid size.
virtual void	getFluxes (const Vector< Array< MultiFab , 3 > > &a_flux, const Vector< MultiFab > &a_sol, Location a_loc) const
	Extract per-direction fluxes for each AMR level.
virtual void	getFluxes (const Vector< MultiFab * > &a_flux, const Vector< MultiFab * > &a_sol) const
	Extract fluxes when the operator stores them in single MultiFabs per level.
virtual void	getEBFluxes (const Vector< MultiFab * > &a_flux, const Vector< MultiFab * > &a_sol) const
	Extract embedded-boundary fluxes.
virtual bool	supportsAnisotropicCoarsening () const
	True if the operator supports MG levels coarsened in any subset of directions. Then MLMG coarsens stretched cells only in their short directions until they are nearly cubic.
virtual GpuArray< Real, 3 >	anisotropicCoarseningCellSize (Geometry const &geom) const
	Cell size used to pick the directions to coarsen when supportsAnisotropicCoarsening() is true. A direction with weaker coupling counts as having longer cells.
virtual bool	supportNSolve () const
	Whether this operator supports NSolve.
virtual void	copyNSolveSolution (MultiFab &dst, MultiFab const &src) const
	Copy an NSolve solution from `src` to `dst`.
virtual void	postSolve (Vector< MultiFab * > const &sol) const
	Optional hook invoked after the main solve completes.
virtual void	avgDownResMG (int clev, MultiFab &cres, MultiFab const &fres) const
	Average residuals from fine to coarse MG levels (FMG helper).
virtual void	beginPrecondBC ()
	Called when the operator starts being used as a preconditioner.
virtual void	endPrecondBC ()
	Called when the operator stops being used as a preconditioner.
bool	isMFIterSafe (int amrlev, int mglev1, int mglev2) const
	Check whether mixing MFIter loops for different MG levels is safe.
int	NAMRLevels () const noexcept
	Return the number of AMR levels.
int	NMGLevels (int amrlev) const noexcept
	Return the number of MG levels at given AMR level.
const Geometry &	Geom (int amr_lev, int mglev=0) const noexcept
	Geometry accessor for (`amr_lev`,`mglev`).

Static Public Attributes
static constexpr int	nelems = 6

Additional Inherited Members
Public Types inherited from amrex::MLNodeLinOp
enum struct	CoarseningStrategy : int { Sigma , RAP }
Public Types inherited from amrex::MLLinOpT< MultiFab >
using	MFType
using	FAB
using	RT
using	BCType
using	BCMode
using	StateMode
using	Location
Static Public Member Functions inherited from amrex::MLNodeLinOp
static std::unique_ptr< iMultiFab >	makeOwnerMask (const BoxArray &ba, const DistributionMapping &dm, const Geometry &geom)
	Build a nodal mask that marks points owned by this rank (used for sync).
Public Attributes inherited from amrex::MLLinOpT< MultiFab >
Vector< Array< BCType, 3 > >	m_lobc
Vector< Array< BCType, 3 > >	m_hibc
Vector< Array< BCType, 3 > >	m_lobc_orig
Vector< Array< BCType, 3 > >	m_hibc_orig
Protected Member Functions inherited from amrex::MLNodeLinOp
void	resizeMultiGrid (int new_size) override
void	buildMGHierarchy () override
	Build the MG levels of AMR level 0 below the finest one.
Protected Member Functions inherited from amrex::MLLinOpT< MultiFab >
const Vector< int > &	AMRRefRatio () const noexcept
	Return AMR refinement ratios.
int	AMRRefRatio (int amr_lev) const noexcept
	Return AMR refinement ratio at given AMR level.
IntVect	AMRRefRatioVect (int amr_lev) const noexcept
	Return AMR refinement ratio as IntVect (1 in hidden direction).
FabFactory< FAB > const *	Factory (int amr_lev, int mglev=0) const noexcept
GpuArray< BCType, 3 >	LoBC (int icomp=0) const noexcept
GpuArray< BCType, 3 >	HiBC (int icomp=0) const noexcept
bool	hasBC (BCType bct) const noexcept
bool	hasInhomogNeumannBC () const noexcept
bool	hasRobinBC () const noexcept
virtual bool	supportRobinBC () const noexcept
virtual bool	supportInhomogNeumannBC () const noexcept
bool	isBottomActive () const noexcept
MPI_Comm	BottomCommunicator () const noexcept
MPI_Comm	Communicator () const noexcept
void	setCoarseFineBCLocation (const RealVect &cloc) noexcept
bool	doAgglomeration () const noexcept
bool	doConsolidation () const noexcept
bool	doSemicoarsening () const noexcept
bool	isCellCentered () const noexcept
virtual IntVect	getNGrowVectRestriction () const
virtual void	make (Vector< Vector< MultiFab > > &mf, IntVect const &ng) const
virtual MultiFab	make (int amrlev, int mglev, IntVect const &ng) const
virtual MultiFab	make (int amrlev, int mglev, IntVect const &ng, MFInfo const &mf_info) const
	As above, with caller-selected allocation metadata for temporary storage.
virtual MultiFab	makeAlias (MultiFab const &mf) const
virtual MultiFab	makeCoarseMG (int amrlev, int mglev, IntVect const &ng) const
	Allocate an `MF` on the next coarser MG level (`mglev+1`) with grow cells `ng`.
virtual MultiFab	makeCoarseMG (int amrlev, int mglev, IntVect const &ng, MFInfo const &mf_info) const
	As above, with caller-selected allocation metadata for temporary storage.
virtual MultiFab	makeCoarseAmr (int famrlev, IntVect const &ng) const
	Allocate an `MF` on the next coarser AMR level (`famrlev-1`) with grow cells `ng`.
virtual MultiFab	makeCoarseAmr (int famrlev, IntVect const &ng, MFInfo const &mf_info) const
	As above, with caller-selected allocation metadata for temporary storage.
virtual std::unique_ptr< FabFactory< FAB > >	makeFactory (int, int) const
void	prepareMGHierarchy ()
	Build the deferred MG levels of AMR level 0 once. See supportsAnisotropicCoarsening.
bool	hasHiddenDimension () const noexcept
int	hiddenDirection () const noexcept
Box	compactify (Box const &b) const noexcept
Array4< T >	compactify (Array4< T > const &a) const noexcept
T	get_d0 (T const &dx, T const &dy, T const &) const noexcept
T	get_d1 (T const &, T const &dy, T const &dz) const noexcept
Protected Attributes inherited from amrex::MLNodeLinOp
std::unique_ptr< iMultiFab >	m_owner_mask_top
std::unique_ptr< iMultiFab >	m_owner_mask_bottom
Vector< Vector< std::unique_ptr< iMultiFab > > >	m_dirichlet_mask
Vector< std::unique_ptr< iMultiFab > >	m_cc_fine_mask
Vector< std::unique_ptr< iMultiFab > >	m_nd_fine_mask
Vector< std::unique_ptr< LayoutData< int > > >	m_has_fine_bndry
MultiFab	m_bottom_dot_mask
MultiFab	m_coarse_dot_mask
Vector< MultiFab >	m_precond_weight_mask
Vector< std::unique_ptr< iMultiFab > >	m_norm_fine_mask
CoarseningStrategy	m_coarsening_strategy = CoarseningStrategy::RAP
bool	m_masks_built = false
bool	m_overset_dirichlet_mask = false
int	m_smooth_num_sweeps = 2
bool	m_in_solution_mode = true
Protected Attributes inherited from amrex::MLLinOpT< MultiFab >
int	mg_box_min_width
int	mg_domain_min_width
int	mg_agg_no_split_direction
bool	mg_odd_coarsening
bool	mg_independent_coarsening
LPInfo	info
int	verbose
std::string	print_ident
int	maxorder
bool	enforceSingularSolvable
bool	m_mg_deferred
	MG levels of AMR level 0 built at first solve.
bool	m_mg_built
int	m_num_amr_levels
Vector< int >	m_amr_ref_ratio
Vector< int >	m_num_mg_levels
const MLLinOpT< MultiFab > *	m_parent
IntVect	m_ixtype
bool	m_do_agglomeration
bool	m_do_consolidation
bool	m_do_semicoarsening
Vector< IntVect >	mg_coarsen_ratio_vec
Vector< Vector< Geometry > >	m_geom
	first Vector is for amr level and second is mg level
Vector< Vector< BoxArray > >	m_grids
Vector< Vector< DistributionMapping > >	m_dmap
Vector< Vector< std::unique_ptr< FabFactory< FAB > > > >	m_factory
Vector< int >	m_domain_covered
MPI_Comm	m_default_comm
MPI_Comm	m_bottom_comm
std::unique_ptr< CommContainer >	m_raii_comm
Array< Real, 3 >	m_domain_bloc_lo
Array< Real, 3 >	m_domain_bloc_hi
bool	m_needs_coarse_data_for_bc
LinOpBCType	m_coarse_fine_bc_type
IntVect	m_coarse_data_crse_ratio
RealVect	m_coarse_bc_loc
const MultiFab *	m_coarse_data_for_bc
MultiFab	m_coarse_data_for_bc_raii
bool	m_precond_mode
Static Protected Attributes inherited from amrex::MLLinOpT< MultiFab >
static constexpr int	mg_coarsen_ratio

Constructor & Destructor Documentation

◆ MLNodeTensorLaplacian() [1/4]

amrex::MLNodeTensorLaplacian::MLNodeTensorLaplacian ( )

default

◆ MLNodeTensorLaplacian() [2/4]

amrex::MLNodeTensorLaplacian::MLNodeTensorLaplacian	(	const Vector< Geometry > &	a_geom,
		const Vector< BoxArray > &	a_grids,
		const Vector< DistributionMapping > &	a_dmap,
		const LPInfo &	a_info = LPInfo() )

◆ ~MLNodeTensorLaplacian()

amrex::MLNodeTensorLaplacian::~MLNodeTensorLaplacian ( )

overridedefault

◆ MLNodeTensorLaplacian() [3/4]

amrex::MLNodeTensorLaplacian::MLNodeTensorLaplacian ( const MLNodeTensorLaplacian & )

delete

◆ MLNodeTensorLaplacian() [4/4]

amrex::MLNodeTensorLaplacian::MLNodeTensorLaplacian ( MLNodeTensorLaplacian && )

delete

Member Function Documentation

◆ averageDownSolutionRHS()

void amrex::MLNodeTensorLaplacian::averageDownSolutionRHS	(	int	camrlev,
		MultiFab &	crse_sol,
		MultiFab &	crse_rhs,
		const MultiFab &	fine_sol,
		const MultiFab &	fine_rhs )

finalvirtual

Average fine AMR data (fine_sol, fine_rhs) into coarse arrays (crse_sol, crse_rhs) on level camrlev.

Reimplemented from amrex::MLLinOpT< MultiFab >.

◆ define()

void amrex::MLNodeTensorLaplacian::define	(	const Vector< Geometry > &	a_geom,
		const Vector< BoxArray > &	a_grids,
		const Vector< DistributionMapping > &	a_dmap,
		const LPInfo &	a_info = LPInfo() )

Bind the tensor operator to the AMR hierarchy (no EB support).

Parameters

a_geom	Per-level geometries.
a_grids	Per-level grids.
a_dmap	Distribution mappings.
a_info	Optional LPInfo overrides.

◆ Fapply()

void amrex::MLNodeTensorLaplacian::Fapply	(	int	amrlev,
		int	mglev,
		MultiFab &	out,
		const MultiFab &	in ) const

finalvirtual

Apply the tensor Laplacian to in at (amrlev,mglev).

Implements amrex::MLNodeLinOp.

◆ fillAlgMatrix()

void amrex::MLNodeTensorLaplacian::fillAlgMatrix	(	int	,
		MFIter const &	,
		Array4< Long const > const &	,
		Array4< int const > const &	,
		Long *	,
		Long *	,
		Real *	) const

overridevirtual

Fill the matrix rows of one box for the algebraic solver.

Same packed layout as the Hypre version: ncols[lid] entries per row, diagonal first, neighbors without a row dropped. The MG level is on AMR level 0. Global row ids are numeric_limits<Long>::max() and local ids negative where there is no row.

Reimplemented from amrex::MLNodeLinOp.

◆ fillMatrix_doit()

template<typename AlgInt, typename AlgGid>

void amrex::MLNodeTensorLaplacian::fillMatrix_doit	(	int	mglev,
		MFIter const &	mfi,
		Array4< AlgGid const > const &	gid,
		Array4< int const > const &	lid,
		AlgInt *	ncols,
		AlgInt *	cols,
		Real *	mat ) const

◆ fillRHS()

void amrex::MLNodeTensorLaplacian::fillRHS	(	int	mglev,
		MFIter const &	mfi,
		Array4< int const > const &	lid,
		Real *	rhs,
		Array4< Real const > const &	bfab ) const

overridevirtual

Fill the RHS vector for nodal tensor solves.

Parameters

mglev	MG level of AMR level 0.
mfi	MultiFab iterator.
lid	Local ID array.
rhs	RHS values (output).
bfab	Source MultiFab data.

Reimplemented from amrex::MLNodeLinOp.

◆ fixUpResidualMask()

void amrex::MLNodeTensorLaplacian::fixUpResidualMask	(	int	amrlev,
		iMultiFab &	resmsk )

finalvirtual

Adjust residual masks resmsk so tensor Dirichlet EB nodes remain fixed.

Reimplemented from amrex::MLNodeLinOp.

◆ Fsmooth()

void amrex::MLNodeTensorLaplacian::Fsmooth	(	int	amrlev,
		int	mglev,
		MultiFab &	sol,
		const MultiFab &	rhs ) const

finalvirtual

Execute the nodal tensor smoother on (amrlev,mglev).

Parameters

amrlev	AMR level index.
mglev	Multigrid level index.
sol	Correction updated in place.
rhs	Right-hand side for the sweep.

Implements amrex::MLNodeLinOp.

◆ interpolation()

void amrex::MLNodeTensorLaplacian::interpolation	(	int	amrlev,
		int	fmglev,
		MultiFab &	fine,
		const MultiFab &	crse ) const

finalvirtual

Add the prolongation of coarse data onto the fine grid (fine += prolong(crse)).

Implements amrex::MLLinOpT< MultiFab >.

◆ name()

std::string amrex::MLNodeTensorLaplacian::name ( ) const

inlinenodiscardoverridevirtual

Reimplemented from amrex::MLLinOpT< MultiFab >.

◆ needsUpdate()

bool amrex::MLNodeTensorLaplacian::needsUpdate ( ) const

inlinenodiscardfinalvirtual

True after setSigma or setBeta, so that cached matrices are rebuilt.

Reimplemented from amrex::MLLinOpT< MultiFab >.

◆ normalize()

void amrex::MLNodeTensorLaplacian::normalize	(	int	amrlev,
		int	mglev,
		MultiFab &	mf ) const

finalvirtual

Divide mf by the diagonal of the operator (used by CG-family bottom solvers).

Reimplemented from amrex::MLLinOpT< MultiFab >.

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

MLNodeTensorLaplacian & amrex::MLNodeTensorLaplacian::operator= ( MLNodeTensorLaplacian && )

delete

◆ prepareForSolve()

void amrex::MLNodeTensorLaplacian::prepareForSolve ( )

finalvirtual

Finalize tensor coefficients and BC caches before solving.

Reimplemented from amrex::MLNodeLinOp.

◆ reflux()

void amrex::MLNodeTensorLaplacian::reflux	(	int	crse_amrlev,
		MultiFab &	res,
		const MultiFab &	crse_sol,
		const MultiFab &	crse_rhs,
		MultiFab &	fine_res,
		MultiFab &	fine_sol,
		const MultiFab &	fine_rhs ) const

finalvirtual

Flux-register reflux between coarse/fine tensor solves; updates res and fine_res using solutions and RHS on AMR index crse_amrlev.

Reimplemented from amrex::MLLinOpT< MultiFab >.

◆ restriction()

void amrex::MLNodeTensorLaplacian::restriction	(	int	amrlev,
		int	cmglev,
		MultiFab &	crse,
		MultiFab &	fine ) const

finalvirtual

Restrict nodal tensor data from fine to coarse on AMR level amrlev / MG level cmglev.

Implements amrex::MLLinOpT< MultiFab >.

◆ setBeta()

void amrex::MLNodeTensorLaplacian::setBeta ( Array< Real, 3 > const & a_beta )

noexcept

Convenience helper that sets sigma = I - beta beta^T.

Parameters

a_beta Vector beta used to build sigma.

◆ setSigma()

void amrex::MLNodeTensorLaplacian::setSigma ( Array< Real, nelems > const & a_sigma )

noexcept

Configure the symmetric tensor sigma.

For 2D the array stores {xx, xy, yy}; for 3D it stores {xx, xy, xz, yy, yz, zz}.

Parameters

a_sigma Components of the symmetric tensor.

◆ smooth()

void amrex::MLNodeTensorLaplacian::smooth	(	int	amrlev,
		int	mglev,
		MultiFab &	sol,
		const MultiFab &	rhs,
		bool	skip_fillboundary,
		int	niter ) const

finalvirtual

Tensor-aware smoother override for nodal data (updates sol against rhs for niter passes; set skip_fillboundary when ghosts are valid).

Reimplemented from amrex::MLNodeLinOp.

◆ supportsAlgMG()

bool amrex::MLNodeTensorLaplacian::supportsAlgMG ( ) const

inlinenodiscardoverridevirtual

True if makeAlgMG is implemented for this operator.

Reimplemented from amrex::MLLinOpT< MultiFab >.

◆ update()

void amrex::MLNodeTensorLaplacian::update ( )

inlinefinalvirtual

Update for reuse.

Reimplemented from amrex::MLLinOpT< MultiFab >.

Member Data Documentation

◆ nelems

int amrex::MLNodeTensorLaplacian::nelems = 6

staticconstexpr

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

/home/runner/work/amrex/amrex/Src/LinearSolvers/MLMG/AMReX_MLNodeTensorLaplacian.H
/home/runner/work/amrex/amrex/Src/LinearSolvers/MLMG/AMReX_MLNodeTensorLaplacian.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ MLNodeTensorLaplacian() [1/4]

◆ MLNodeTensorLaplacian() [2/4]

◆ ~MLNodeTensorLaplacian()

◆ MLNodeTensorLaplacian() [3/4]

◆ MLNodeTensorLaplacian() [4/4]

Member Function Documentation

◆ averageDownSolutionRHS()

◆ define()

◆ Fapply()

◆ fillAlgMatrix()

◆ fillMatrix_doit()

◆ fillRHS()

◆ fixUpResidualMask()

◆ Fsmooth()

◆ interpolation()

◆ name()

◆ needsUpdate()

◆ normalize()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ prepareForSolve()

◆ reflux()

◆ restriction()

◆ setBeta()

◆ setSigma()

◆ smooth()

◆ supportsAlgMG()

◆ update()

Member Data Documentation

◆ nelems