MFHelmholtzOp Class Reference

Operator for solving multifluid Helmholtz on a grid level. More...

#include <CD_MFHelmholtzOp.H>

Inheritance diagram for MFHelmholtzOp:

Collaboration diagram for MFHelmholtzOp:

Public Types
enum class	Smoother {   PointJacobi , GauSaiRedBlack , GauSaiMultiColor , Chebyshev ,   RestrictedAdditiveSchwarz }
	Relaxation methods for this operator.

Public Member Functions
	MFHelmholtzOp ()=delete
	Constructor. Must subsequently call define(...)
	MFHelmholtzOp (const MFHelmholtzOp &a_op)=delete
	No copy construction allowed.
	MFHelmholtzOp (const MFHelmholtzOp &&a_op)=delete
	No move construction allowed.
	MFHelmholtzOp (const Location::Cell a_dataLocation, const MFLevelGrid &a_mflgFine, const MFLevelGrid &a_mflg, const MFLevelGrid &a_mflgCoFi, const MFLevelGrid &a_mflgCoar, const MFLevelGrid &a_mflgCoarMG, const MFMultigridInterpolator &a_interpolator, const MFReflux &a_fluxReg, const MFCoarAve &a_coarAve, const RefCountedPtr< LevelData< BaseFab< bool > > > &a_validCells, const RefCountedPtr< MFHelmholtzDomainBCFactory > &a_domainBC, const RefCountedPtr< MFHelmholtzEBBCFactory > &a_ebBC, const RefCountedPtr< MFHelmholtzJumpBCFactory > &a_jumpBcFactory, const RealVect &a_probLo, const Real &a_dx, const int &a_refToFine, const int &a_refToCoar, const bool &a_hasFine, const bool &a_hasCoar, const bool &a_hasMGObjects, const bool &a_isMGOperator, const Real &a_alpha, const Real &a_beta, const RefCountedPtr< LevelData< MFCellFAB > > &a_Acoef, const RefCountedPtr< LevelData< MFFluxFAB > > &a_Bcoef, const RefCountedPtr< LevelData< MFBaseIVFAB > > &a_BcoefIrreg, const IntVect &a_ghostPhi, const IntVect &a_ghostRhs, const int &a_jumpOrder, const int &a_jumpWeight, const int &a_preCondSmooth, const Smoother &a_relaxType, const Real &a_relaxFactor, const int &a_chebyOrder, const Real &a_chebyEigRatio, const int &a_rasInnerSweeps, const bool a_refluxFree=false)
	Full constructor.
virtual	~MFHelmholtzOp ()
	Destructor.
MFHelmholtzOp &	operator= (const MFHelmholtzOp &a_oper)=delete
	No copy assignment allowed.
MFHelmholtzOp &	operator= (const MFHelmholtzOp &&a_oper)=delete
	No move assignment allowed.
void	setAcoAndBco (const RefCountedPtr< LevelData< MFCellFAB > > &a_Acoef, const RefCountedPtr< LevelData< MFFluxFAB > > &a_Bcoef, const RefCountedPtr< LevelData< MFBaseIVFAB > > &a_BcoefIrreg)
	Update operators with new coefficients.
const RefCountedPtr< LevelData< MFCellFAB > > &	getAcoef ()
	Get the Helmholtz A-coefficient on cell centers.
const RefCountedPtr< LevelData< MFFluxFAB > > &	getBcoef ()
	Get the Helmholtz B-coefficient on faces.
const RefCountedPtr< LevelData< MFBaseIVFAB > > &	getBcoefIrreg ()
	Get the Helmholtz B-coefficient on the EB.
void	setJump (RefCountedPtr< LevelData< BaseIVFAB< Real > > > &a_jump)
	Set the jump boundary condition.
RefCountedPtr< EBHelmholtzOp > &	getHelmOp (const int a_phase)
	Get Helmholtz operator.
int	refToCoarser () override final
	Return coarsening factor to coarser level (1 if there is no coarser level);.
void	setAlphaAndBeta (const Real &a_alpha, const Real &a_beta) override final
	Set alpha and beta.
void	divideByIdentityCoef (LevelData< MFCellFAB > &a_rhs) override final
	Divide by the a-coefficient.
void	applyOpNoBoundary (LevelData< MFCellFAB > &a_ans, const LevelData< MFCellFAB > &a_phi) override final
	Apply operator but turn off all BCs.
void	fillGrad (const LevelData< MFCellFAB > &a_phi) override final
	Not called, I think.
void	getFlux (MFFluxFAB &a_flux, const LevelData< MFCellFAB > &a_data, const Box &a_grid, const DataIndex &a_dit, Real a_scale) override final
	Fill flux.
void	residual (LevelData< MFCellFAB > &a_residual, const LevelData< MFCellFAB > &a_phi, const LevelData< MFCellFAB > &a_rhs, const bool a_homogeneousPhysBc) override final
	Compute residual on this level.
void	preCond (LevelData< MFCellFAB > &a_corr, const LevelData< MFCellFAB > &a_residual) override final
	Precondition system before bottom solve.
void	applyOp (LevelData< MFCellFAB > &a_Lphi, const LevelData< MFCellFAB > &a_phi, bool a_homogeneousPhysBc) override final
	Apply operator.
template<typename Duration = std::chrono::microseconds>
Vector< long long >	computeOperatorLoads (LevelData< MFCellFAB > &a_phi, const int a_numApply) noexcept
	Time the applyOp routine. Template parameter is std::chrono duration. E.g. std::chrono::microseconds.
void	relax (LevelData< MFCellFAB > &a_correction, const LevelData< MFCellFAB > &a_residual, int a_iterations) override final
	Relaxation method. This does smoothing for the system L(correction) = residual.
void	relaxPointJacobi (LevelData< MFCellFAB > &a_correction, const LevelData< MFCellFAB > &a_residual, const int a_iterations)
	Jacobi relaxation.
void	relaxGSRedBlack (LevelData< MFCellFAB > &a_correction, const LevelData< MFCellFAB > &a_residual, const int a_iterations)
	Jacobi relaxation.
void	relaxGSMultiColor (LevelData< MFCellFAB > &a_correction, const LevelData< MFCellFAB > &a_residual, const int a_iterations)
	Multi-colored gauss-seidel relaxation.
void	relaxChebyshev (LevelData< MFCellFAB > &a_correction, const LevelData< MFCellFAB > &a_residual, const int a_iterations)
	Chebyshev polynomial smoother.
void	relaxRestrictedAdditiveSchwarz (LevelData< MFCellFAB > &a_correction, const LevelData< MFCellFAB > &a_residual, const int a_iterations)
	Restricted additive Schwarz smoother (block smoother).
void	create (LevelData< MFCellFAB > &a_lhs, const LevelData< MFCellFAB > &a_rhs) override final
	Create method.
void	createCoarser (LevelData< MFCellFAB > &a_coarse, const LevelData< MFCellFAB > &a_fine, bool a_ghosted) override final
	Create coarsened data.
void	createCoarsened (LevelData< MFCellFAB > &a_lhs, const LevelData< MFCellFAB > &a_rhs, const int &a_refRat) override final
	Create coarsening of data holder.
void	incr (LevelData< MFCellFAB > &a_lhs, const LevelData< MFCellFAB > &a_rhs, Real a_scale) override final
	Increment function.
Real	dotProduct (const LevelData< MFCellFAB > &a_lhs, const LevelData< MFCellFAB > &a_rhs) override final
	Dot product.
void	dotProductMaskedLocal (Real &a_sumKappaXY, Real &a_sumVolume, const LevelData< MFCellFAB > &a_lhs, const LevelData< MFCellFAB > &a_rhs, const LevelData< BaseFab< bool > > &a_mask, const bool a_needVolume) const noexcept
	Rank-local (un-reduced) partials for the masked AMR-composite Krylov inner product (summed over phases).
void	scale (LevelData< MFCellFAB > &a_lhs, const Real &a_scale) override final
	Scale function.
void	setToZero (LevelData< MFCellFAB > &a_lhs) override final
	Set to zero.
void	assign (LevelData< MFCellFAB > &a_lhs, const LevelData< MFCellFAB > &a_rhs) override final
	Assignment function.
void	assignCopier (LevelData< MFCellFAB > &a_lhs, const LevelData< MFCellFAB > &a_rhs, const Copier &a_copier) override final
	Assign lhs.
void	assignLocal (LevelData< MFCellFAB > &a_lhs, const LevelData< MFCellFAB > &a_rhs) override final
	Local assignment function.
void	buildCopier (Copier &a_copier, const LevelData< MFCellFAB > &a_lhs, const LevelData< MFCellFAB > &a_rhs) override
	Build copier.
Real	norm (const LevelData< MFCellFAB > &a_lhs, int a_order) override final
	Compute solution norm.
void	axby (LevelData< MFCellFAB > &a_lhs, const LevelData< MFCellFAB > &a_x, const LevelData< MFCellFAB > &a_y, const Real a_a, const Real a_b) override final
	Set a_lhs = a*x + b*y.
void	restrictResidual (LevelData< MFCellFAB > &a_resCoar, LevelData< MFCellFAB > &a_phi, const LevelData< MFCellFAB > &a_rhs) override final
	Restrict residual onto coarse level.
void	prolongIncrement (LevelData< MFCellFAB > &a_phi, const LevelData< MFCellFAB > &a_correctCoarse) override final
	Prolongation method.
void	AMRUpdateResidual (LevelData< MFCellFAB > &a_residual, const LevelData< MFCellFAB > &a_correction, const LevelData< MFCellFAB > &a_coarseCorrection) override final
	Update AMR residual.
void	AMRRestrict (LevelData< MFCellFAB > &a_residualCoarse, const LevelData< MFCellFAB > &a_residual, const LevelData< MFCellFAB > &a_correction, const LevelData< MFCellFAB > &a_coarseCorrection, bool a_skip_res) override final
	Restrict residual.
void	AMRProlong (LevelData< MFCellFAB > &a_correction, const LevelData< MFCellFAB > &a_coarseCorrection) override final
	Prolongation onto AMR level.
void	AMRResidual (LevelData< MFCellFAB > &a_residual, const LevelData< MFCellFAB > &a_phiFine, const LevelData< MFCellFAB > &a_phi, const LevelData< MFCellFAB > &a_phiCoar, const LevelData< MFCellFAB > &a_rhs, bool a_homogeneousPhysBC, AMRLevelOp< LevelData< MFCellFAB > > *a_finerOp) override final
	Compute residual on this level. AMR version.
void	AMRResidualNF (LevelData< MFCellFAB > &a_residual, const LevelData< MFCellFAB > &a_phi, const LevelData< MFCellFAB > &a_phiCoar, const LevelData< MFCellFAB > &a_rhs, bool a_homogeneousPhysBC) override final
	Compute AMR residual on finest AMR level.
void	AMRResidualNC (LevelData< MFCellFAB > &a_residual, const LevelData< MFCellFAB > &a_phiFine, const LevelData< MFCellFAB > &a_phi, const LevelData< MFCellFAB > &a_rhs, bool a_homogeneousPhysBC, AMRLevelOp< LevelData< MFCellFAB > > *a_finerOp) override final
	Compute AMR residual on coarsest.
void	AMROperatorNF (LevelData< MFCellFAB > &a_Lphi, const LevelData< MFCellFAB > &a_phi, const LevelData< MFCellFAB > &a_phiCoar, bool a_homogeneousPhysBC) override final
	Apply the AMR operator, i.e. compute L(phi) in an AMR context, assuming no finer levels.
void	AMROperatorNC (LevelData< MFCellFAB > &a_Lphi, const LevelData< MFCellFAB > &a_phiFine, const LevelData< MFCellFAB > &a_phi, bool a_homogeneousPhysBC, AMRLevelOp< LevelData< MFCellFAB > > *a_finerOp) override final
	Apply the AMR operator, i.e. compute L(phi) in an AMR context, assuming no coarser AMR levels.

Protected Member Functions
void	updateJumpBC (const LevelData< MFCellFAB > &a_phi, const bool a_homogeneousPhysBC)
	Update the jump condition.
void	exchangeGhost (const LevelData< MFCellFAB > &a_phi) const
	Perform an exchange operation, event if the data is const.
void	interpolateCF (const LevelData< MFCellFAB > &a_phi, const LevelData< MFCellFAB > *a_phiCoar, const bool a_homogeneousCF)
	Do coarse-fine interpolation.
void	applyOp (LevelData< MFCellFAB > &a_Lphi, const LevelData< MFCellFAB > &a_phi, const LevelData< MFCellFAB > *const a_phiCoar, const bool a_homogeneousPhysBC, const bool a_homogeneousCFBC)
	Apply operator on this level. This is a more general version which can turn on/off homogeneous and CF bcs.
void	AMROperator (LevelData< MFCellFAB > &a_Lphi, const LevelData< MFCellFAB > &a_phiFine, const LevelData< MFCellFAB > &a_phi, const LevelData< MFCellFAB > &a_phiCoar, const bool a_homogeneousPhysBC, AMRLevelOp< LevelData< MFCellFAB > > *a_finerOp) override
	Apply the AMR operator, i.e. compute L(phi) in an AMR context.

Protected Attributes
Location::Cell	m_dataLocation
	Interpretation of data. Either on cell center or on cell centroid.
Smoother	m_smoother
	Relaxation method.
Vector< IntVect >	m_colors
	"Colors" for the multi-coloered relaxation method
std::map< int, RefCountedPtr< EBHelmholtzOp > >	m_helmOps
	Helmholtz operators on each phase. Note that I'm using int rather than Phase as identifier because that is the standard terminology for MFCellFAB.
RefCountedPtr< MFHelmholtzJumpBC >	m_jumpBC
	BC jump object. This is the one that has the stencils and can compute derivatives.
RefCountedPtr< LevelData< BaseIVFAB< Real > > >	m_jump
	Actual BC jump in data-based format. This is the right-hand side of dphi/dn1 + dphi/dn2 = jump.
RefCountedPtr< LevelData< BaseFab< bool > > >	m_validCells
	Valid grid cells (will be nullpointer on MG levels)
std::map< int, RefCountedPtr< LevelData< BaseIVFAB< Real > > > >	m_dirichletBcValues
	Dirichlet BC values for each phase.
MFLevelGrid	m_mflg
	Level grid.
MFLevelGrid	m_mflgFine
	Fine level grid.
MFLevelGrid	m_mflgCoar
	Coarse grid.
MFLevelGrid	m_mflgCoFi
	Coarsened version of this grid.
MFLevelGrid	m_mflgCoarMG
	Coarse multigrid-grid.
MFMultigridInterpolator	m_interpolator
	Multi grid interpolator.
MFCoarAve	m_coarAve
	Coarsener.
RefCountedPtr< LevelData< MFCellFAB > >	m_Acoef
	Helmholtz A-coefficient.
RefCountedPtr< LevelData< MFFluxFAB > >	m_Bcoef
	Helmholtz B-coefficient.
RefCountedPtr< LevelData< MFBaseIVFAB > >	m_BcoefIrreg
	Helmholtz B-coefficient on EB.
Copier	m_exchangeCopier
	Copier for exchange operation.
bool	m_multifluid
	Multifluid operator or not.
bool	m_hasMGObjects
	Has MG objects or not.
int	m_numSmoothPreCond
	Number of smoothings in the preconditioner.
int	m_numPhases
	Number of phases.
int	m_refToCoar
	Refinement factor to coarser AMR level.
IntVect	m_ghostPhi
	Number of ghost cells.
IntVect	m_ghostRhs
	Number of ghost cells.
bool	m_hasCoar
	True if there is a coarser AMR level.
bool	m_hasFine
	True if there is a finer AMR level.
bool	m_hasMGObjcts
	True if there are multigrid levels.

Static Protected Attributes
static constexpr int	m_comp = 0
	Component that we solve for.
static constexpr int	m_nComp = 1
	Number of components that we solve for.

Detailed Description

Operator for solving multifluid Helmholtz on a grid level.

This operator should typically not be constructed directly by the user but used together with Chombo's AMRMultiGrid. In this case the user will want to constructor these operators through the factor.

Constructor & Destructor Documentation

MFHelmholtzOp()

MFHelmholtzOp::MFHelmholtzOp	(	const Location::Cell	a_dataLocation,
		const MFLevelGrid &	a_mflgFine,
		const MFLevelGrid &	a_mflg,
		const MFLevelGrid &	a_mflgCoFi,
		const MFLevelGrid &	a_mflgCoar,
		const MFLevelGrid &	a_mflgCoarMG,
		const MFMultigridInterpolator &	a_interpolator,
		const MFReflux &	a_fluxReg,
		const MFCoarAve &	a_coarAve,
		const RefCountedPtr< LevelData< BaseFab< bool > > > &	a_validCells,
		const RefCountedPtr< MFHelmholtzDomainBCFactory > &	a_domainBC,
		const RefCountedPtr< MFHelmholtzEBBCFactory > &	a_ebBC,
		const RefCountedPtr< MFHelmholtzJumpBCFactory > &	a_jumpBcFactory,
		const RealVect &	a_probLo,
		const Real &	a_dx,
		const int &	a_refToFine,
		const int &	a_refToCoar,
		const bool &	a_hasFine,
		const bool &	a_hasCoar,
		const bool &	a_hasMGObjects,
		const bool &	a_isMGOperator,
		const Real &	a_alpha,
		const Real &	a_beta,
		const RefCountedPtr< LevelData< MFCellFAB > > &	a_Acoef,
		const RefCountedPtr< LevelData< MFFluxFAB > > &	a_Bcoef,
		const RefCountedPtr< LevelData< MFBaseIVFAB > > &	a_BcoefIrreg,
		const IntVect &	a_ghostPhi,
		const IntVect &	a_ghostRhs,
		const int &	a_jumpOrder,
		const int &	a_jumpWeight,
		const int &	a_preCondSmooth,
		const Smoother &	a_relaxType,
		const Real &	a_relaxFactor,
		const int &	a_chebyOrder,
		const Real &	a_chebyEigRatio,
		const int &	a_rasInnerSweeps,
		const bool	a_refluxFree = false
	)

Full constructor.

Parameters

[in]	a_dataLocation	Data location, either cell center or cell centroid
[in]	a_mflgFine	Fine grids
[in]	a_mflg	Grids on this level
[in]	a_mflgCoFi	Coarsening of fine level grids
[in]	a_mflgCoar	Coarse grids
[in]	a_mflgCoarMG	Multigrid-grids
[in]	a_validCells	Valid grid cells (will be null on MG levels)
[in]	a_interpolator	Interpolator
[in]	a_fluxReg	Flux register
[in]	a_coarAve	Coarsener
[in]	a_domainBC	Domain BC
[in]	a_ebBC	Boundary conditions on EBs
[in]	a_jumpBcFactory	Factory class for making jump BCs
[in]	a_probLo	Lower-left corner of computational domain
[in]	a_dx	Grid resolution
[in]	a_refToFine	Refinement ratio to fine level
[in]	a_refToCoar	Refinement ratio to coarse level
[in]	a_hasFine	Has fine level or not
[in]	a_hasCoar	Has coarse level or not
[in]	a_hasMGObjects	Has multigrid-objects (special objects between AMR levels, or below the AMR levels)
[in]	a_isMGOperator	Is MG operator or not
[in]	a_alpha	Operator alpha
[in]	a_beta	Operator beta
[in]	a_Acoef	Operator A-coefficient
[in]	a_Bcoef	Operator B-coefficient
[in]	a_BcoefIrreg	Operator B-coefficient (on EB faces)
[in]	a_jumpOrder	Stencil order to use on jump cells
[in]	a_relaxType	Which smoother to use
[in]	a_relaxFactor	Relaxation factor
[in]	a_chebyOrder	Chebyshev polynomial degree (only used when a_relaxType is Smoother::Chebyshev)
[in]	a_chebyEigRatio	Chebyshev eigenvalue ratio lambda_max/lambda_min (only used when a_relaxType is Smoother::Chebyshev)
[in]	a_rasInnerSweeps	Number of inner frozen-ghost sweeps per restricted-additive-Schwarz iteration (only used when a_relaxType is Smoother::RestrictedAdditiveSchwarz)
[in]	a_refluxFree	If true, use the reflux-free AMR operator (skips coarse-fine flux refluxing)
[in]	a_ghostPhi	Description
[in]	a_ghostRhs	Description
[in]	a_jumpWeight	Description
[in]	a_preCondSmooth	Description

Member Function Documentation

AMROperator()

void MFHelmholtzOp::AMROperator ( LevelData< MFCellFAB > &  a_Lphi, const LevelData< MFCellFAB > &  a_phiFine, const LevelData< MFCellFAB > &  a_phi, const LevelData< MFCellFAB > &  a_phiCoar, const bool  a_homogeneousPhysBC, AMRLevelOp< LevelData< MFCellFAB > > *  a_finerOp  )

overrideprotected

Apply the AMR operator, i.e. compute L(phi) in an AMR context.

Parameters

[in]	a_phiFine	Phi on fine level
[in]	a_phi	Phi on this level
[in]	a_phiCoar	Phi on coar level
[in]	a_homogeneousPhysBC	Use homogeneous physical BCs or not
[in]	a_finerOp	Finer operator

This involves ghost cell interpolation if there's a coarse level, and refluxing if there's a fine level.

Parameters

[in]

a_Lphi

Lphi

AMROperatorNC()

void MFHelmholtzOp::AMROperatorNC ( LevelData< MFCellFAB > &  a_Lphi, const LevelData< MFCellFAB > &  a_phiFine, const LevelData< MFCellFAB > &  a_phi, bool  a_homogeneousPhysBC, AMRLevelOp< LevelData< MFCellFAB > > *  a_finerOp  )

finaloverride

Apply the AMR operator, i.e. compute L(phi) in an AMR context, assuming no coarser AMR levels.

Parameters

[out]	a_Lphi	L(phi)
[in]	a_phiFine	Phi on fine level
[in]	a_phi	Phi on this level
[in]	a_homogeneousPhysBC	Use homogeneous physical BCs or not
[in]	a_finerOp	Finer operator

This involves ghost cell interpolation if there's a coarse level, and refluxing if there's a fine level.

AMROperatorNF()

void MFHelmholtzOp::AMROperatorNF ( LevelData< MFCellFAB > &  a_Lphi, const LevelData< MFCellFAB > &  a_phi, const LevelData< MFCellFAB > &  a_phiCoar, bool  a_homogeneousPhysBC  )

finaloverride

Apply the AMR operator, i.e. compute L(phi) in an AMR context, assuming no finer levels.

Parameters

[out]	a_Lphi	L(phi)
[in]	a_phi	Phi on this level
[in]	a_phiCoar	Phi on coar level
[in]	a_homogeneousPhysBC	Use homogeneous physical BCs or not

This involves ghost cell interpolation if there's a coarse level, and refluxing if there's a fine level.

AMRProlong()

void MFHelmholtzOp::AMRProlong ( LevelData< MFCellFAB > &  a_correction, const LevelData< MFCellFAB > &  a_coarseCorrection  )

finaloverride

Prolongation onto AMR level.

Parameters

[out]	a_correction	Interpolated correction
[in]	a_coarseCorrection	Correction on coarse level

AMRResidual()

void MFHelmholtzOp::AMRResidual ( LevelData< MFCellFAB > &  a_residual, const LevelData< MFCellFAB > &  a_phiFine, const LevelData< MFCellFAB > &  a_phi, const LevelData< MFCellFAB > &  a_phiCoar, const LevelData< MFCellFAB > &  a_rhs, bool  a_homogeneousPhysBC, AMRLevelOp< LevelData< MFCellFAB > > *  a_finerOp  )

finaloverride

Compute residual on this level. AMR version.

Parameters

[out]	a_residual	Residual on this level
[in]	a_phiFine	Phi on fine level
[in]	a_phi	Phi on this level
[in]	a_phiCoar	Phi on coar level
[in]	a_rhs	Right-hand side on this level
[in]	a_homogeneousPhysBC	Use homogeneous physical BCs or not
[in]	a_finerOp	Finer operator

AMRResidualNC()

void MFHelmholtzOp::AMRResidualNC ( LevelData< MFCellFAB > &  a_residual, const LevelData< MFCellFAB > &  a_phiFine, const LevelData< MFCellFAB > &  a_phi, const LevelData< MFCellFAB > &  a_rhs, bool  a_homogeneousPhysBC, AMRLevelOp< LevelData< MFCellFAB > > *  a_finerOp  )

finaloverride

Compute AMR residual on coarsest.

Parameters

[out]	a_residual	Residual on this level
[in]	a_phiFine	Phi on fine level
[in]	a_phi	Phi on this level
[in]	a_rhs	Right-hand side on this level
[in]	a_homogeneousPhysBC	Use homogeneous physical BCs or not
[in]	a_finerOp	Finer operator

AMRResidualNF()

void MFHelmholtzOp::AMRResidualNF ( LevelData< MFCellFAB > &  a_residual, const LevelData< MFCellFAB > &  a_phi, const LevelData< MFCellFAB > &  a_phiCoar, const LevelData< MFCellFAB > &  a_rhs, bool  a_homogeneousPhysBC  )

finaloverride

Compute AMR residual on finest AMR level.

Parameters

[out]	a_residual	Residual on this level
[in]	a_phi	Phi on this level
[in]	a_phiCoar	Phi on coar level
[in]	a_rhs	Right-hand side on this level
[in]	a_homogeneousPhysBC	Use homogeneous physical BCs or not

AMRRestrict()

void MFHelmholtzOp::AMRRestrict ( LevelData< MFCellFAB > &  a_residualCoarse, const LevelData< MFCellFAB > &  a_residual, const LevelData< MFCellFAB > &  a_correction, const LevelData< MFCellFAB > &  a_coarseCorrection, bool  a_skip_res  )

finaloverride

Restrict residual.

Parameters

[out]	a_residualCoarse	Coarse residual
[out]	a_residual	Residual
[out]	a_correction	Correction on this level
[out]	a_coarseCorrection	Coarse level correction
[in]	a_skip_res	I have no idea what this one is supposed to do.

AMRUpdateResidual()

void MFHelmholtzOp::AMRUpdateResidual ( LevelData< MFCellFAB > &  a_residual, const LevelData< MFCellFAB > &  a_correction, const LevelData< MFCellFAB > &  a_coarseCorrection  )

finaloverride

Update AMR residual.

Parameters

[in]	a_residual	Residual
[in]	a_correction	Correction
[in]	a_coarseCorrection	Coarse-level correction

applyOp() [1/2]

void MFHelmholtzOp::applyOp ( LevelData< MFCellFAB > &  a_Lphi, const LevelData< MFCellFAB > &  a_phi, bool  a_homogeneousPhysBc  )

finaloverride

Apply operator.

Parameters

[out]	a_Lphi	L(phi)
[in]	a_phi	Phi
[in]	a_homogeneousPhysBc	Homogeneous physical BCs or not

This computes a_Lphi = L(a_phi) using homogeneous physical BCs or not

applyOp() [2/2]

void MFHelmholtzOp::applyOp ( LevelData< MFCellFAB > &  a_Lphi, const LevelData< MFCellFAB > &  a_phi, const LevelData< MFCellFAB > *const  a_phiCoar, const bool  a_homogeneousPhysBC, const bool  a_homogeneousCFBC  )

protected

Apply operator on this level. This is a more general version which can turn on/off homogeneous and CF bcs.

Parameters

[out]	a_Lphi	L(phi)
[out]	a_phi	Phi on this level
[out]	a_phiCoar	Coarse-level phi. If you have a coar this
[in]	a_homogeneousPhysBC	Use homogeneous physical BCs or not
[in]	a_homogeneousCFBC	Use homogeneous coarse-fine bcs or not

Note

a_phi is not really const and we do a nasty cast. Leaving it as const because we only modify the ghost cells!

applyOpNoBoundary()

void MFHelmholtzOp::applyOpNoBoundary ( LevelData< MFCellFAB > &  a_ans, const LevelData< MFCellFAB > &  a_phi  )

finaloverride

Apply operator but turn off all BCs.

Parameters

[in,out]	a_ans	L(phi) on output
[in]	a_phi	Phi

assign()

void MFHelmholtzOp::assign ( LevelData< MFCellFAB > &  a_lhs, const LevelData< MFCellFAB > &  a_rhs  )

finaloverride

Assignment function.

Parameters

[out]	a_lhs	Equal to a_rhs on output
[in]	a_rhs	Data

assignCopier()

void MFHelmholtzOp::assignCopier ( LevelData< MFCellFAB > &  a_lhs, const LevelData< MFCellFAB > &  a_rhs, const Copier &  a_copier  )

finaloverride

Assign lhs.

This is the version that is called by AMRMultiGrid::VCycle. Note that the other version might be called by other operators (e.g., EBBackwardEuler)

Parameters

[out]	a_lhs	Outgoing data
[in]	a_rhs	Incoming data
[in]	a_copier	Copier

assignLocal()

void MFHelmholtzOp::assignLocal ( LevelData< MFCellFAB > &  a_lhs, const LevelData< MFCellFAB > &  a_rhs  )

finaloverride

Local assignment function.

Parameters

[out]	a_lhs	Equal to a_rhs on output
[in]	a_rhs	Data

axby()

void MFHelmholtzOp::axby ( LevelData< MFCellFAB > &  a_lhs, const LevelData< MFCellFAB > &  a_x, const LevelData< MFCellFAB > &  a_y, const Real  a_a, const Real  a_b  )

finaloverride

Set a_lhs = a*x + b*y.

Parameters

[out]	a_lhs	Result data
[in]	a_x	x-data
[in]	a_y	y-data
[in]	a_a	Scaling factor
[in]	a_b	Scaling factor

buildCopier()

void MFHelmholtzOp::buildCopier ( Copier &  a_copier, const LevelData< MFCellFAB > &  a_lhs, const LevelData< MFCellFAB > &  a_rhs  )

override

Build copier.

Parameters

[out]	a_copier	Copier for copying between a_lhs and a_rhs
[in]	a_lhs	Copying from
[in]	a_rhs	Copying to

computeOperatorLoads()

template<typename Duration >

Vector< long long > MFHelmholtzOp::computeOperatorLoads ( LevelData< MFCellFAB > &  a_phi, const int  a_numApply  )

noexcept

Time the applyOp routine. Template parameter is std::chrono duration. E.g. std::chrono::microseconds.

Parameters

[in]	a_phi	Dummy cell-centered data. must have the correct number of ghost cells
[in]	a_numApply	Number of times we apply the operator.

Returns

List of execution times in microseconds, ordered along the input DBLs boxArray()

create()

void MFHelmholtzOp::create ( LevelData< MFCellFAB > &  a_lhs, const LevelData< MFCellFAB > &  a_rhs  )

finaloverride

Create method.

Parameters

[out]	a_lhs	Clone
[out]	a_rhs	Original data

createCoarsened()

void MFHelmholtzOp::createCoarsened ( LevelData< MFCellFAB > &  a_lhs, const LevelData< MFCellFAB > &  a_rhs, const int &  a_refRat  )

finaloverride

Create coarsening of data holder.

Parameters

[out]	a_lhs	Coarsened data
[in]	a_rhs	Fine data
[in]	a_refRat	Coarsening factor

createCoarser()

void MFHelmholtzOp::createCoarser ( LevelData< MFCellFAB > &  a_coarse, const LevelData< MFCellFAB > &  a_fine, bool  a_ghosted  )

finaloverride

Create coarsened data.

Parameters

[out]	a_coarse	Coarse data
[in]	a_fine	Fine data
[in]	a_ghosted	Include ghost cells or nto

divideByIdentityCoef()

void MFHelmholtzOp::divideByIdentityCoef ( LevelData< MFCellFAB > &  a_rhs )

finaloverride

Divide by the a-coefficient.

Parameters

[in,out]

a_rhs

Divided data

dotProduct()

Real MFHelmholtzOp::dotProduct ( const LevelData< MFCellFAB > &  a_lhs, const LevelData< MFCellFAB > &  a_rhs  )

finaloverride

Dot product.

Returns

Return value

Parameters

[in]	a_lhs	First operand
[in]	a_rhs	Second operand

dotProductMaskedLocal()

void MFHelmholtzOp::dotProductMaskedLocal ( Real &  a_sumKappaXY, Real &  a_sumVolume, const LevelData< MFCellFAB > &  a_lhs, const LevelData< MFCellFAB > &  a_rhs, const LevelData< BaseFab< bool > > &  a_mask, const bool  a_needVolume  ) const

noexcept

Rank-local (un-reduced) partials for the masked AMR-composite Krylov inner product (summed over phases).

Same kappa-weighted inner product as dotProduct (summed over all phases), except cells where a_mask is false (e.g. cells covered by a finer AMR level) are excluded from the numerator; the volume normalisation counts all valid cells, matching Chombo's MultilevelLinearOp AMR dot product. The mask is per-cell and shared across phases. Unlike dotProduct this performs NO MPI reduction: it returns the rank-local partial sums so the caller (AMRMultigridKrylovOp) can batch the per-level partials into a single MPI_Allreduce. The volume is geometry-only and is reduced/cached once by the caller, so a_needVolume can be set false on later calls to skip recomputing it.

Parameters

[out]	a_sumKappaXY	Rank-local masked numerator (sum of kappa*X*Y over unmasked cells, both phases)
[out]	a_sumVolume	Rank-local volume (sum over all valid cells); set to zero when a_needVolume is false
[in]	a_lhs	First operand
[in]	a_rhs	Second operand
[in]	a_mask	Per-cell mask; false marks cells excluded from the numerator
[in]	a_needVolume	If false, skip accumulating a_sumVolume (caller already cached it)

exchangeGhost()

void MFHelmholtzOp::exchangeGhost ( const LevelData< MFCellFAB > &  a_phi ) const

protected

Perform an exchange operation, event if the data is const.

Parameters

[in]

a_phi

Data

fillGrad()

void MFHelmholtzOp::fillGrad ( const LevelData< MFCellFAB > &  a_phi )

finaloverride

Not called, I think.

Parameters

[in]

a_phi

Phi

getAcoef()

const RefCountedPtr< LevelData< MFCellFAB > > & MFHelmholtzOp::getAcoef

(

)

Get the Helmholtz A-coefficient on cell centers.

Returns

m_Acoef

getBcoef()

const RefCountedPtr< LevelData< MFFluxFAB > > & MFHelmholtzOp::getBcoef

(

)

Get the Helmholtz B-coefficient on faces.

Returns

m_Bcoef

getBcoefIrreg()

const RefCountedPtr< LevelData< MFBaseIVFAB > > & MFHelmholtzOp::getBcoefIrreg

(

)

Get the Helmholtz B-coefficient on the EB.

Returns

m_Bcoef

getFlux()

void MFHelmholtzOp::getFlux ( MFFluxFAB &  a_flux, const LevelData< MFCellFAB > &  a_data, const Box &  a_grid, const DataIndex &  a_dit, Real  a_scale  )

finaloverride

Fill flux.

Parameters

[out]	a_flux	Flux
[in]	a_data	Data for which we will compute the flux
[in]	a_grid	Grid
[in]	a_dit	Corresponding data index.
[in]	a_scale	Scaling factor

getHelmOp()

RefCountedPtr< EBHelmholtzOp > & MFHelmholtzOp::getHelmOp

(

const int

a_phase

)

Get Helmholtz operator.

Returns

Helm op

Parameters

[in]

a_phase

Description

incr()

void MFHelmholtzOp::incr ( LevelData< MFCellFAB > &  a_lhs, const LevelData< MFCellFAB > &  a_rhs, Real  a_scale  )

finaloverride

Increment function.

Parameters

[in,out]	a_lhs	On output, a_lhs = a_lhs + a_rhs*a_scale
[in]	a_rhs	Data
[in]	a_scale	Scaling factor

interpolateCF()

void MFHelmholtzOp::interpolateCF ( const LevelData< MFCellFAB > &  a_phi, const LevelData< MFCellFAB > *  a_phiCoar, const bool  a_homogeneousCF  )

protected

Do coarse-fine interpolation.

Parameters

[in,out]	a_phi	Fine-level data
[in]	a_phiCoar	Coarse-level data
[in]	a_homogeneousCF	Homogeneous interpolation or not.

Note

Only ghost cells in a_phi are touched.

norm()

Real MFHelmholtzOp::norm ( const LevelData< MFCellFAB > &  a_lhs, int  a_order  )

finaloverride

Compute solution norm.

Parameters

[in]	a_lhs	Data
[in]	a_order	Norm order. Not used.

Returns

Return value

preCond()

void MFHelmholtzOp::preCond ( LevelData< MFCellFAB > &  a_corr, const LevelData< MFCellFAB > &  a_residual  )

finaloverride

Precondition system before bottom solve.

Parameters

[in]	a_corr	Correction
[in]	a_residual	Residual

This just runs a few relaxations.

prolongIncrement()

void MFHelmholtzOp::prolongIncrement ( LevelData< MFCellFAB > &  a_phi, const LevelData< MFCellFAB > &  a_correctCoarse  )

finaloverride

Prolongation method.

Parameters

[out]	a_phi	Correction on this level
[out]	a_correctCoarse	Correction on coarse level

refToCoarser()

int MFHelmholtzOp::refToCoarser ( )

finaloverride

Return coarsening factor to coarser level (1 if there is no coarser level);.

Returns

Return value

relax()

void MFHelmholtzOp::relax ( LevelData< MFCellFAB > &  a_correction, const LevelData< MFCellFAB > &  a_residual, int  a_iterations  )

finaloverride

Relaxation method. This does smoothing for the system L(correction) = residual.

Parameters

[in,out]	a_correction	Correction
[in]	a_residual	Residual
[in]	a_iterations	Number of iterations

relaxChebyshev()

void MFHelmholtzOp::relaxChebyshev	(	LevelData< MFCellFAB > &	a_correction,
		const LevelData< MFCellFAB > &	a_residual,
		const int	a_iterations
	)

Chebyshev polynomial smoother.

Parameters

[in,out]	a_correction	Correction
[in]	a_residual	Residual
[in]	a_iterations	Number of iterations

relaxGSMultiColor()

void MFHelmholtzOp::relaxGSMultiColor	(	LevelData< MFCellFAB > &	a_correction,
		const LevelData< MFCellFAB > &	a_residual,
		const int	a_iterations
	)

Multi-colored gauss-seidel relaxation.

Parameters

[in,out]	a_correction	Correction
[in]	a_residual	Residual
[in]	a_iterations	Number of iterations

relaxGSRedBlack()

void MFHelmholtzOp::relaxGSRedBlack	(	LevelData< MFCellFAB > &	a_correction,
		const LevelData< MFCellFAB > &	a_residual,
		const int	a_iterations
	)

Jacobi relaxation.

Parameters

[in,out]	a_correction	Correction
[in]	a_residual	Residual
[in]	a_iterations	Number of iterations

relaxPointJacobi()

void MFHelmholtzOp::relaxPointJacobi	(	LevelData< MFCellFAB > &	a_correction,
		const LevelData< MFCellFAB > &	a_residual,
		const int	a_iterations
	)

Jacobi relaxation.

Parameters

[in,out]	a_correction	Correction
[in]	a_residual	Residual
[in]	a_iterations	Number of iterations

relaxRestrictedAdditiveSchwarz()

void MFHelmholtzOp::relaxRestrictedAdditiveSchwarz	(	LevelData< MFCellFAB > &	a_correction,
		const LevelData< MFCellFAB > &	a_residual,
		const int	a_iterations
	)

Restricted additive Schwarz smoother (block smoother).

Exchanges ghost cells once per outer iteration and then performs a number of frozen-ghost red-black sweeps per patch (inexact local Dirichlet solve). The block (inner-sweep) count is taken from the first phase operator.

Parameters

[in,out]	a_correction	Correction
[in]	a_residual	Residual
[in]	a_iterations	Number of outer Schwarz iterations

residual()

void MFHelmholtzOp::residual ( LevelData< MFCellFAB > &  a_residual, const LevelData< MFCellFAB > &  a_phi, const LevelData< MFCellFAB > &  a_rhs, const bool  a_homogeneousPhysBc  )

finaloverride

Compute residual on this level.

Parameters

[out]	a_residual	Residual rhs - L(phi)
[in]	a_phi	phi
[in]	a_rhs	Right-hand side of system
[in]	a_homogeneousPhysBc	Homogeneous phys bc

restrictResidual()

void MFHelmholtzOp::restrictResidual ( LevelData< MFCellFAB > &  a_resCoar, LevelData< MFCellFAB > &  a_phi, const LevelData< MFCellFAB > &  a_rhs  )

finaloverride

Restrict residual onto coarse level.

Parameters

[in,out]	a_resCoar	Coarse residual
[in,out]	a_phi	Phi on this level
[in]	a_rhs	Rhs on this level

scale()

void MFHelmholtzOp::scale ( LevelData< MFCellFAB > &  a_lhs, const Real &  a_scale  )

finaloverride

Scale function.

Parameters

[in,out]	a_lhs	On output, a_lhs = a_lhs*a_scale
[in]	a_scale	Scaling factor

setAcoAndBco()

void MFHelmholtzOp::setAcoAndBco	(	const RefCountedPtr< LevelData< MFCellFAB > > &	a_Acoef,
		const RefCountedPtr< LevelData< MFFluxFAB > > &	a_Bcoef,
		const RefCountedPtr< LevelData< MFBaseIVFAB > > &	a_BcoefIrreg
	)

Update operators with new coefficients.

Parameters

[in]	a_Acoef	Operator A-coefficient
[in]	a_Bcoef	Operator B-coefficient
[in]	a_BcoefIrreg	Operator B-coefficient (on EB faces)

setAlphaAndBeta()

void MFHelmholtzOp::setAlphaAndBeta ( const Real &  a_alpha, const Real &  a_beta  )

finaloverride

Set alpha and beta.

Parameters

[in]	a_alpha	Alpha
[in]	a_beta	Beta

setJump()

void MFHelmholtzOp::setJump

(

RefCountedPtr< LevelData< BaseIVFAB< Real > > > &

a_jump

)

Set the jump boundary condition.

Parameters

[in,out]

a_jump

Description

setToZero()

void MFHelmholtzOp::setToZero ( LevelData< MFCellFAB > &  a_lhs )

finaloverride

Set to zero.

Parameters

[out]

a_lhs

Data

updateJumpBC()

void MFHelmholtzOp::updateJumpBC ( const LevelData< MFCellFAB > &  a_phi, const bool  a_homogeneousPhysBC  )

protected

Update the jump condition.

Parameters

[in]	a_phi	Data
[in]	a_homogeneousPhysBC	homogeneous physical BC or not

---

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

• Source/Elliptic/CD_MFHelmholtzOp.H
• Source/Elliptic/CD_MFHelmholtzOp.cpp
• Source/Elliptic/CD_MFHelmholtzOpImplem.H