Class to encapsulate Gradient functions (both CC and face-centered) More...

#include <Gradient.H>

Static Public Member Functions
static void	levelGradientCC (LevelData< FArrayBox > &a_grad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > *a_phiCrsePtr, const Real a_dx, const int a_nRefCrse, const ProblemDomain &a_dProblem)
	computes cell-centered level-operator gradient of cell-centered phi More...

static void	levelGradientCC (LevelData< FArrayBox > &a_grad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > *a_phiCrsePtr, const Real a_dx, const int a_nRefCrse, const Box &a_dProblem)
	computes cell-centered level-operator gradient of cell-centered phi More...

static void	levelGradientCC (LevelData< FArrayBox > &a_grad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > *a_phiCrsePtr, const Real a_dx, const LayoutData< IntVectSet > &a_gridIVS, QuadCFInterp &a_cfInterp)
	computes cell-centered level-operator gradient of cell-centered phi More...

static void	levelGradientCC (LevelData< FArrayBox > &a_grad, const LevelData< FArrayBox > &a_phi, const Real a_dx)
	computes cell-centered, level-operator gradient of cell-centered phi More...

static void	levelGradientCC_HO (LevelData< FArrayBox > &a_grad, const LevelData< FArrayBox > &a_phi, const Real a_dx)
	Higher order method.

static void	levelGradientCC (LevelData< FArrayBox > &a_grad, const LevelData< FluxBox > &a_phi, const Real a_dx)
	computes cell-centered, level-operator gradient of face-centered phi More...

static void	levelGradientCC (LevelData< FArrayBox > &a_grad, const LevelData< FArrayBox > &a_phi, const Real a_dx, const int nGhost)
	computes cell-centered, level-operator gradient of cell-centered phi More...

static void	levelGradientCCUpwind (LevelData< FArrayBox > &a_grad, const LevelData< FArrayBox > &a_phi, const Real a_dx)
	computes onesided, level-operator gradient of cell-centered phi More...

static void	levelGradientCCUpwind (LevelData< FArrayBox > &a_grad, const LevelData< FArrayBox > &a_phi, const Real a_dx, const Side::LoHiSide extrapSide, int order=2)
	computes level-operator gradient of cell-centred phi More...

static void	levelGradientCCNewOneSided (LevelData< FArrayBox > &a_grad, const LevelData< FArrayBox > &a_phi, const Real a_dx, int order=2)
	computes level-operator gradient of cell-centered phi More...

static void	levelGradientCCNewCentred (LevelData< FArrayBox > &a_grad, const LevelData< FArrayBox > &a_phi, const Real a_dx, int order=2)

static void	compGradientCC (LevelData< FArrayBox > &a_grad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > a_phiCrsePtr, const LevelData< FArrayBox > a_phiFinePtr, const Real a_dx, const int a_nRefCrse, const int a_nRefFine, const ProblemDomain &a_dProblem)
	computes cell-centered composite gradient of cell centered phi More...

static void	compGradientCC (LevelData< FArrayBox > &a_grad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > a_phiCrsePtr, const LevelData< FArrayBox > a_phiFinePtr, const Real a_dx, const int a_nRefCrse, const int a_nRefFine, const Box &a_dProblem)
	computes cell-centered composite gradient of cell centered phi More...

static void	compGradientCC (LevelData< FArrayBox > &a_grad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > a_phiCrsePtr, const LevelData< FArrayBox > a_phiFinePtr, const Real a_dx, const int a_nRefFine, const ProblemDomain &a_dProblem, const LayoutData< IntVectSet > &a_gridIVS, QuadCFInterp &a_cfInterpCrse)
	computes cell-centered composite gradient of cell-centered phi More...

static void	compGradientCC (LevelData< FArrayBox > &a_grad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > a_phiCrsePtr, const LevelData< FArrayBox > a_phiFinePtr, const Real a_dx, const int a_nRefFine, const Box &a_dProblem, const LayoutData< IntVectSet > &a_gridIVS, QuadCFInterp &a_cfInterpCrse)
	computes cell-centered composite gradient of cell-centered phi More...

static void	compGradientCC (LevelData< FArrayBox > &a_Grad, const LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > *a_phiFinePtr, const Real a_dx, const int a_nRefFine, const ProblemDomain &a_dProblem)
	computes cell-centered composite gradient of cell-centered phi More...

static void	compGradientCC (LevelData< FArrayBox > &a_Grad, const LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > *a_phiFinePtr, const Real a_dx, const int a_nRefFine, const Box &a_dProblem)
	computes cell-centered composite gradient of cell-centered phi More...

static void	levelGradientMAC (LevelData< FluxBox > &a_edgeGrad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > *a_phiCrsePtr, const Real a_dx, const int a_nRefCrse, const ProblemDomain &a_dProblem)
	computes edge-centered level-operator gradient of cell-centered phi More...

static void	levelGradientMAC (LevelData< FluxBox > &a_edgeGrad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > *a_phiCrsePtr, const Real a_dx, const int a_nRefCrse, const Box &a_dProblem)
	computes edge-centered level-operator gradient of cell-centered phi More...

static void	levelGradientMAC (LevelData< FluxBox > &a_edgeGrad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > *a_phiCrsePtr, const Real a_dx, const LayoutData< IntVectSet > &a_gridIVS, QuadCFInterp &a_cfInterpCrse)
	computes edge-centered level-operator gradient of cell-centered phi More...

static void	levelGradientMAC (LevelData< FluxBox > &a_edgeGrad, const LevelData< FArrayBox > &a_phi, const Real a_dx)
	computes edge-centered level-operator gradient of cell-centered phi More...

static void	levelGradientMACNew (LevelData< FluxBox > &a_edgeGrad, const LevelData< FArrayBox > &a_phi, const Real a_dx)
	Edge centred gradient, new version, assume ghost cells have been set.

static void	compGradientMAC (LevelData< FluxBox > &a_edgeGrad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > a_phiCrse, const LevelData< FArrayBox > a_phiFine, const Real a_dx, const int a_nRefCrse, const int a_nRefFine, const Box &a_dProblem)
	computes edge-centered composite gradient of cell-centered phi More...

static void	compGradientMAC (LevelData< FluxBox > &a_edgeGrad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > a_phiCrse, const LevelData< FArrayBox > a_phiFine, const Real a_dx, const int a_nRefCrse, const int a_nRefFine, const ProblemDomain &a_dProblem)
	computes edge-centered composite gradient of cell-centered phi More...

static void	compGradientMAC (LevelData< FluxBox > &a_edgeGrad, LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > a_phiCrse, const LevelData< FArrayBox > a_phiFine, const Real a_dx, const int a_nRefFine, const LayoutData< IntVectSet > &a_gridIVS, QuadCFInterp &a_cfInterpCrse)
	computes edge-centered composite gradient of cell-centered phi More...

static void	singleBoxMacGrad (FArrayBox &a_gradFab, const FArrayBox &a_phiFab, int a_gradComp, int a_phiComp, int a_numComp, const Box &a_edgeBox, Real a_dx, int a_dir, int a_edgeDir, const IntVectSet &a_gridIVS)
	utility function for internal use

static void	createGridIVS (LayoutData< IntVectSet > &a_gridsIVS, const DisjointBoxLayout &a_grids, const int a_nGrow)
	create grid IVS for all grids More...

static void	createGridIVS (IntVectSet &a_gridIVS, const DisjointBoxLayout &a_grids, const Box &a_localBox, const int a_nGrow=1)
	internal utility function More...

Detailed Description

Class to encapsulate Gradient functions (both CC and face-centered)

Member Function Documentation

◆ compGradientCC() [1/6]

void Gradient::compGradientCC	(	LevelData< FArrayBox > &	a_grad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrsePtr,
		const LevelData< FArrayBox > *	a_phiFinePtr,
		const Real	a_dx,
		const int	a_nRefCrse,
		const int	a_nRefFine,
		const ProblemDomain &	a_dProblem
	)

static

computes cell-centered composite gradient of cell centered phi

Uses same coarse-level C/F BC's as LevelGradientCC, if phiFinePtr != NULL, then also uses one-sided differencing to compute gradient on coarse side of coarse-fine interface.

◆ compGradientCC() [2/6]

void Gradient::compGradientCC	(	LevelData< FArrayBox > &	a_grad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrsePtr,
		const LevelData< FArrayBox > *	a_phiFinePtr,
		const Real	a_dx,
		const int	a_nRefCrse,
		const int	a_nRefFine,
		const Box &	a_dProblem
	)

static

computes cell-centered composite gradient of cell centered phi

uses same coarse-level C/F BC's as LevelGradientCC, if phiFinePtr != NULL, then also uses one-sided differencing to compute gradient on coarse side of coarse-fine interface. This (deprecated) interface uses a Box instead of a ProblemDomain

◆ compGradientCC() [3/6]

void Gradient::compGradientCC	(	LevelData< FArrayBox > &	a_grad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrsePtr,
		const LevelData< FArrayBox > *	a_phiFinePtr,
		const Real	a_dx,
		const int	a_nRefFine,
		const ProblemDomain &	a_dProblem,
		const LayoutData< IntVectSet > &	a_gridIVS,
		QuadCFInterp &	a_cfInterpCrse
	)

static

computes cell-centered composite gradient of cell-centered phi

uses same coarse-level C/F BC's as LevelGradientCC, if phiFinePtr != NULL, then also uses one-sided differencing to compute gradient on coarse side of coarse-fine interface. A predefined QuadCFInterp is also passed in for efficiency. Note that no fine QuadCFInterp is necessary because we use one-sided differencing for coarse cells adjacent to finer-level coarse-fine interfaces. Note also that gradient is only really defined in valid regions of grids.

◆ compGradientCC() [4/6]

void Gradient::compGradientCC	(	LevelData< FArrayBox > &	a_grad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrsePtr,
		const LevelData< FArrayBox > *	a_phiFinePtr,
		const Real	a_dx,
		const int	a_nRefFine,
		const Box &	a_dProblem,
		const LayoutData< IntVectSet > &	a_gridIVS,
		QuadCFInterp &	a_cfInterpCrse
	)

static

computes cell-centered composite gradient of cell-centered phi

uses same coarse-level C/F BC's as LevelGradientCC, if phiFinePtr != NULL, then also uses one-sided differencing to compute gradient on coarse side of coarse-fine interface. A predefined QuadCFInterp is also passed in for efficiency. Note that no fine QuadCFInterp is necessary because we use one-sided differencing for coarse cells adjacent to finer-level coarse-fine interfaces. Note also that gradient is only really defined in valid regions of grids. This (deprecated) interface uses a Box instead of a ProblemDomain

◆ compGradientCC() [5/6]

void Gradient::compGradientCC	(	LevelData< FArrayBox > &	a_Grad,
		const LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiFinePtr,
		const Real	a_dx,
		const int	a_nRefFine,
		const ProblemDomain &	a_dProblem
	)

static

computes cell-centered composite gradient of cell-centered phi

this one assumes that all ghost-cell values have already been set; if phiFinePtr != NULL, then also uses one-sided differencing to compute gradient on coarse side of corarse-fine interface. note that gradient is only really defined in valid regions of grids.

◆ compGradientCC() [6/6]

void Gradient::compGradientCC	(	LevelData< FArrayBox > &	a_Grad,
		const LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiFinePtr,
		const Real	a_dx,
		const int	a_nRefFine,
		const Box &	a_dProblem
	)

static

computes cell-centered composite gradient of cell-centered phi

this one assumes that all ghost-cell values have already been set; if phiFinePtr != NULL, then also uses one-sided differencing to compute gradient on coarse side of corarse-fine interface. note that gradient is only really defined in valid regions of grids. This (deprecated) interface uses a Box instead of a ProblemDomain

◆ compGradientMAC() [1/3]

void Gradient::compGradientMAC	(	LevelData< FluxBox > &	a_edgeGrad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrse,
		const LevelData< FArrayBox > *	a_phiFine,
		const Real	a_dx,
		const int	a_nRefCrse,
		const int	a_nRefFine,
		const Box &	a_dProblem
	)

static

computes edge-centered composite gradient of cell-centered phi

if phiCrsePtr != NULL, does quadratic interpolation to compute coarse-fine boundary conditions for phi; since the edge between this level and finer levels is not considered to be a part of this level, there is no fine-level coarse-fine BC. because of this, this function produces exactly the same results as LevelGradientMAC – it's just included for completeness...

◆ compGradientMAC() [2/3]

void Gradient::compGradientMAC	(	LevelData< FluxBox > &	a_edgeGrad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrse,
		const LevelData< FArrayBox > *	a_phiFine,
		const Real	a_dx,
		const int	a_nRefCrse,
		const int	a_nRefFine,
		const ProblemDomain &	a_dProblem
	)

static

computes edge-centered composite gradient of cell-centered phi

if phiCrsePtr != NULL, does quadratic interpolation to compute coarse-fine boundary conditions for phi; since the edge between this level and finer levels is not considered to be a part of this level, there is no fine-level coarse-fine BC. because of this, this function produces exactly the same results as LevelGradientMAC – it's just included for completeness...

◆ compGradientMAC() [3/3]

void Gradient::compGradientMAC	(	LevelData< FluxBox > &	a_edgeGrad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrse,
		const LevelData< FArrayBox > *	a_phiFine,
		const Real	a_dx,
		const int	a_nRefFine,
		const LayoutData< IntVectSet > &	a_gridIVS,
		QuadCFInterp &	a_cfInterpCrse
	)

static

computes edge-centered composite gradient of cell-centered phi

if phiCrsePtr != NULL, does quadratic interpolation to compute coarse-fine boundary conditions for phi; since the edge between this level and finer levels is not considered to be a part of this level, there is no fine-level coarse-fine BC. because of this, this function produces exactly the same results as LevelGradientMAC – it's just included for completeness... In this one, a predefined QuadCFInterp object is passed in. This (deprecated) interface uses a Box instead of a ProblemDomain object

◆ createGridIVS() [1/2]

void Gradient::createGridIVS	(	LayoutData< IntVectSet > &	a_gridsIVS,
		const DisjointBoxLayout &	a_grids,
		const int	a_nGrow
	)

static

create grid IVS for all grids

creates an IVS representation of the DisjointBoxLayout in the neighborhood around each box in the DBL.

◆ createGridIVS() [2/2]

void Gradient::createGridIVS	(	IntVectSet &	a_gridIVS,
		const DisjointBoxLayout &	a_grids,
		const Box &	a_localBox,
		const int	a_nGrow = `1`
	)

static

internal utility function

creates IVS representation of the DisjointBoxLayout in the neighborhood of localBox

◆ levelGradientCC() [1/6]

void Gradient::levelGradientCC	(	LevelData< FArrayBox > &	a_grad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrsePtr,
		const Real	a_dx,
		const int	a_nRefCrse,
		const ProblemDomain &	a_dProblem
	)

static

computes cell-centered level-operator gradient of cell-centered phi

if phiCrse != NULL, does coarse-fine boundary conditions for phi (quadratic interpolation)

◆ levelGradientCC() [2/6]

void Gradient::levelGradientCC	(	LevelData< FArrayBox > &	a_grad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrsePtr,
		const Real	a_dx,
		const int	a_nRefCrse,
		const Box &	a_dProblem
	)

static

computes cell-centered level-operator gradient of cell-centered phi

if phiCrse != NULL, does coarse-fine boundary conditions for phi (quadratic interpolation). This (deprecated) interface uses a Box instead of a ProblemDomain

◆ levelGradientCC() [3/6]

void Gradient::levelGradientCC	(	LevelData< FArrayBox > &	a_grad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrsePtr,
		const Real	a_dx,
		const LayoutData< IntVectSet > &	a_gridIVS,
		QuadCFInterp &	a_cfInterp
	)

static

computes cell-centered level-operator gradient of cell-centered phi

if phiCrse != NULL, does coarse-fine boundary conditions for phi (quadratic C/F interpolation); predefined QuadCFInterp object is passed in for efficiency

◆ levelGradientCC() [4/6]

void Gradient::levelGradientCC	(	LevelData< FArrayBox > &	a_grad,
		const LevelData< FArrayBox > &	a_phi,
		const Real	a_dx
	)

static

computes cell-centered, level-operator gradient of cell-centered phi

in this case, assume that all relevant BC's (coarse-fine and physical) have already been set, so phi can be a const variable

◆ levelGradientCC() [5/6]

void Gradient::levelGradientCC	(	LevelData< FArrayBox > &	a_grad,
		const LevelData< FluxBox > &	a_phi,
		const Real	a_dx
	)

static

computes cell-centered, level-operator gradient of face-centered phi

in this case, assume that all relevant BC's (coarse-fine and physical) have already been set, so phi can be a const variable

◆ levelGradientCC() [6/6]

void Gradient::levelGradientCC	(	LevelData< FArrayBox > &	a_grad,
		const LevelData< FArrayBox > &	a_phi,
		const Real	a_dx,
		const int	nGhost
	)

static

computes cell-centered, level-operator gradient of cell-centered phi

in this case, assume that all relevant BC's (coarse-fine and physical) have already been set, so phi can be a const variable gradient is also calculate in nghost ghost cells, assuming that nghost+1 cells have been filled in phi

◆ levelGradientCCNewCentred()

void Gradient::levelGradientCCNewCentred	(	LevelData< FArrayBox > &	a_grad,
		const LevelData< FArrayBox > &	a_phi,
		const Real	a_dx,
		int	order = `2`
	)

static

Fills interior cells with centred diffs and one set of ghost cells with one sided diffs. All 2nd order.

◆ levelGradientCCNewOneSided()

void Gradient::levelGradientCCNewOneSided	(	LevelData< FArrayBox > &	a_grad,
		const LevelData< FArrayBox > &	a_phi,
		const Real	a_dx,
		int	order = `2`
	)

static

computes level-operator gradient of cell-centered phi

use one sided differences everywhere for smooth errors. Doesn't fill ghost cells

◆ levelGradientCCUpwind() [1/2]

void Gradient::levelGradientCCUpwind	(	LevelData< FArrayBox > &	a_grad,
		const LevelData< FArrayBox > &	a_phi,
		const Real	a_dx
	)

static

computes onesided, level-operator gradient of cell-centered phi

in this case, assume that all relevant BC's (coarse-fine and physical) have already been set, so phi can be a const variable. Uses grid cells at (i,j,k) and (i+1,j+1,k+1)

◆ levelGradientCCUpwind() [2/2]

void Gradient::levelGradientCCUpwind	(	LevelData< FArrayBox > &	a_grad,
		const LevelData< FArrayBox > &	a_phi,
		const Real	a_dx,
		const Side::LoHiSide	extrapSide,
		int	order = `2`
	)

static

computes level-operator gradient of cell-centred phi

Uses upwind stencil

◆ levelGradientMAC() [1/4]

void Gradient::levelGradientMAC	(	LevelData< FluxBox > &	a_edgeGrad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrsePtr,
		const Real	a_dx,
		const int	a_nRefCrse,
		const ProblemDomain &	a_dProblem
	)

static

computes edge-centered level-operator gradient of cell-centered phi

if phiCrsePtr != NULL, does quadratic interpolation to compute coarse-fine boundary conditions for phi

◆ levelGradientMAC() [2/4]

void Gradient::levelGradientMAC	(	LevelData< FluxBox > &	a_edgeGrad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrsePtr,
		const Real	a_dx,
		const int	a_nRefCrse,
		const Box &	a_dProblem
	)

static

computes edge-centered level-operator gradient of cell-centered phi

if phiCrsePtr != NULL, does quadratic interpolation to compute coarse-fine boundary conditions for phi. This (deprecated) interface uses a Box instead of a ProblemDomain

◆ levelGradientMAC() [3/4]

void Gradient::levelGradientMAC	(	LevelData< FluxBox > &	a_edgeGrad,
		LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > *	a_phiCrsePtr,
		const Real	a_dx,
		const LayoutData< IntVectSet > &	a_gridIVS,
		QuadCFInterp &	a_cfInterpCrse
	)

static

computes edge-centered level-operator gradient of cell-centered phi

if phiCrsePtr != NULL, does quadratic interpolation to compute coarse-fine boundary conditions for phi. A predefined QuadCFInterp object is passed in for efficiency

◆ levelGradientMAC() [4/4]

void Gradient::levelGradientMAC	(	LevelData< FluxBox > &	a_edgeGrad,
		const LevelData< FArrayBox > &	a_phi,
		const Real	a_dx
	)

static

computes edge-centered level-operator gradient of cell-centered phi

assumes ALL ghost cell values have been preset (so phi can be const)

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

/home/parkinsonjl/mushy-layer/util/Gradient.H
/home/parkinsonjl/mushy-layer/util/Gradient.cpp

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ compGradientCC() [1/6]

◆ compGradientCC() [2/6]

◆ compGradientCC() [3/6]

◆ compGradientCC() [4/6]

◆ compGradientCC() [5/6]

◆ compGradientCC() [6/6]

◆ compGradientMAC() [1/3]

◆ compGradientMAC() [2/3]

◆ compGradientMAC() [3/3]

◆ createGridIVS() [1/2]

◆ createGridIVS() [2/2]

◆ levelGradientCC() [1/6]

◆ levelGradientCC() [2/6]

◆ levelGradientCC() [3/6]

◆ levelGradientCC() [4/6]

◆ levelGradientCC() [5/6]

◆ levelGradientCC() [6/6]

◆ levelGradientCCNewCentred()

◆ levelGradientCCNewOneSided()

◆ levelGradientCCUpwind() [1/2]

◆ levelGradientCCUpwind() [2/2]

◆ levelGradientMAC() [1/4]

◆ levelGradientMAC() [2/4]

◆ levelGradientMAC() [3/4]

◆ levelGradientMAC() [4/4]