abstract base class for amr ice sheet models (AmrIce, AMRIceControl) More...

#include <AmrIceBase.H>

Inheritance diagram for AmrIceBase:

Public Types
enum	viscousTensorComponent { xx, xy, yx, yy, max }

Public Member Functions
virtual	~AmrIceBase ()

virtual Real	time () const =0

virtual int	finestLevel () const =0

virtual const RealVect	dx (int a_level) const =0

virtual const RefCountedPtr< LevelSigmaCS >	geometry (int a_level) const =0

virtual const DisjointBoxLayout &	grids (int a_level) const =0

virtual const Vector< int > &	refRatios () const =0

virtual const LevelData< FArrayBox > *	velocity (int a_level) const =0

virtual SurfaceFlux &	surfaceHeatBoundaryData () const =0

virtual bool	surfaceHeatBoundaryDirichlett () const =0

virtual bool	surfaceHeatBoundaryTemperature () const =0

virtual SurfaceFlux &	basalHeatBoundaryData () const =0

virtual const LevelData< FArrayBox > *	groundingLineProximity (int a_level) const =0

virtual Real	groundingLineProximityScale () const =0

virtual void	writeAMRHierarchyHDF5 (const string &filename, const Vector< DisjointBoxLayout > &a_grids, const Vector< LevelData< FArrayBox > * > &a_data, const Vector< string > &a_name, const Box &a_domain, const Real &a_dx, const Real &a_dt, const Real &a_time, const Vector< int > &a_ratio, const int &a_numLevels) const =0
	Write an AMR hierarchy to an hdf5 file. More...

Detailed Description

abstract base class for amr ice sheet models (AmrIce, AMRIceControl)

Member Enumeration Documentation

◆ viscousTensorComponent

enum AmrIceBase::viscousTensorComponent

Enumerator
xx
xy
yx
yy
max

Constructor & Destructor Documentation

◆ ~AmrIceBase()

virtual AmrIceBase::~AmrIceBase ( )

inlinevirtual

References basalHeatBoundaryData(), dx(), finestLevel(), geometry(), grids(), groundingLineProximity(), groundingLineProximityScale(), refRatios(), surfaceHeatBoundaryData(), surfaceHeatBoundaryDirichlett(), surfaceHeatBoundaryTemperature(), time(), and velocity().

Member Function Documentation

◆ basalHeatBoundaryData()

virtual SurfaceFlux& AmrIceBase::basalHeatBoundaryData ( ) const

pure virtual

Implemented in AmrIce.

Referenced by VerticalConductionInternalEnergyIBC::initializeIceInternalEnergy(), and ~AmrIceBase().

◆ dx()

virtual const RealVect AmrIceBase::dx ( int a_level ) const

pure virtual

Implemented in AmrIce.

Referenced by LevelDataTemperatureIBC::basalHeatFlux(), ISMIP6OceanForcing::computeBasinMeans(), ISMIP6OceanForcing::computeTFb(), fortranInterfaceFlux::surfaceThicknessFlux(), HotspotFlux::surfaceThicknessFlux(), ISMIP6OceanForcing::surfaceThicknessFlux(), LevelDataSurfaceFlux::surfaceThicknessFlux(), MultiLevelDataSurfaceFlux::surfaceThicknessFlux(), BoxBoundedFlux::surfaceThicknessFlux(), NormalizedFlux::surfaceThicknessFlux(), and ~AmrIceBase().

◆ finestLevel()

virtual int AmrIceBase::finestLevel ( ) const

pure virtual

Implemented in AmrIce.

Referenced by NormalizedFlux::surfaceThicknessFlux(), and ~AmrIceBase().

◆ geometry()

virtual const RefCountedPtr<LevelSigmaCS> AmrIceBase::geometry ( int a_level ) const

pure virtual

Implemented in AmrIce.

Referenced by ISMIP6OceanForcing::computeBasinMeans(), ISMIP6OceanForcing::computeTFb(), VerticalConductionInternalEnergyIBC::initializeIceInternalEnergy(), LevelDataTemperatureIBC::initializeIceInternalEnergy(), PythonInterface::PythonIceTemperatureIBC::initializeIceInternalEnergy(), GroundingLineLocalizedFlux::surfaceThicknessFlux(), MaskedFlux::surfaceThicknessFlux(), PythonInterface::PythonSurfaceFlux::surfaceThicknessFlux(), PiecewiseLinearFlux::surfaceThicknessFlux(), NormalizedFlux::surfaceThicknessFlux(), and ~AmrIceBase().

◆ grids()

virtual const DisjointBoxLayout& AmrIceBase::grids ( int a_level ) const

pure virtual

Implemented in AmrIce.

Referenced by LevelDataTemperatureIBC::basalHeatFlux(), NormalizedFlux::surfaceThicknessFlux(), and ~AmrIceBase().

◆ groundingLineProximity()

virtual const LevelData<FArrayBox>* AmrIceBase::groundingLineProximity ( int a_level ) const

pure virtual

Implemented in AmrIce.

Referenced by PythonInterface::FillKwargs(), GroundingLineLocalizedFlux::surfaceThicknessFlux(), and ~AmrIceBase().

◆ groundingLineProximityScale()

virtual Real AmrIceBase::groundingLineProximityScale ( ) const

pure virtual

Implemented in AmrIce.

Referenced by PythonInterface::FillKwargs(), and ~AmrIceBase().

◆ refRatios()

virtual const Vector<int>& AmrIceBase::refRatios ( ) const

pure virtual

Implemented in AmrIce.

Referenced by NormalizedFlux::surfaceThicknessFlux(), and ~AmrIceBase().

◆ surfaceHeatBoundaryData()

virtual SurfaceFlux& AmrIceBase::surfaceHeatBoundaryData ( ) const

pure virtual

Implemented in AmrIce.

Referenced by VerticalConductionInternalEnergyIBC::initializeIceInternalEnergy(), and ~AmrIceBase().

◆ surfaceHeatBoundaryDirichlett()

virtual bool AmrIceBase::surfaceHeatBoundaryDirichlett ( ) const

pure virtual

Implemented in AmrIce.

Referenced by VerticalConductionInternalEnergyIBC::initializeIceInternalEnergy(), and ~AmrIceBase().

◆ surfaceHeatBoundaryTemperature()

virtual bool AmrIceBase::surfaceHeatBoundaryTemperature ( ) const

pure virtual

Implemented in AmrIce.

Referenced by ~AmrIceBase().

◆ time()

virtual Real AmrIceBase::time ( ) const

pure virtual

Implemented in AmrIce.

Referenced by HotspotFlux::surfaceThicknessFlux(), ISMIP6OceanForcing::surfaceThicknessFlux(), LevelDataSurfaceFlux::surfaceThicknessFlux(), MultiLevelDataSurfaceFlux::surfaceThicknessFlux(), BoxBoundedFlux::surfaceThicknessFlux(), PythonInterface::PythonSurfaceFlux::surfaceThicknessFlux(), and ~AmrIceBase().

◆ velocity()

virtual const LevelData<FArrayBox>* AmrIceBase::velocity ( int a_level ) const

pure virtual

Implemented in AmrIce.

Referenced by NormalizedFlux::surfaceThicknessFlux(), and ~AmrIceBase().

◆ writeAMRHierarchyHDF5()

virtual void AmrIceBase::writeAMRHierarchyHDF5	(	const string &	filename,
		const Vector< DisjointBoxLayout > &	a_grids,
		const Vector< LevelData< FArrayBox > * > &	a_data,
		const Vector< string > &	a_name,
		const Box &	a_domain,
		const Real &	a_dx,
		const Real &	a_dt,
		const Real &	a_time,
		const Vector< int > &	a_ratio,
		const int &	a_numLevels
	)		const

pure virtual

Write an AMR hierarchy to an hdf5 file.

Specifying this as part of the interface permits AmrIceBase aware functions to have e.g AmrIce modify their writes to include standard metadata

Parameters

filename	name of hdf5 file
a_grids	mesh hierarchy
a_data	data hierarchy, defined on a_grids
a_name	component names
a_domain	domain limits on coarse level
a_dx	mesh spacing on coarse level
a_dt	time step on coarsest level
a_time	time
a_ratio	refinement ratio : $\Delta x_{i} = r_i \Delta x_{i+1}$
a_numLevels	number of levels to write