#include <BasalFriction.H>

Inheritance diagram for BasalFriction:

[legend]

Public Member Functions
virtual	~BasalFriction ()
	virtual destructor More...

virtual BasalFriction *	new_basalFriction () const =0
	factory method More...

virtual void	setBasalFriction (LevelData< FArrayBox > &a_betaSqr, LevelSigmaCS &a_coordSys, Real a_time, Real a_dt)=0
	compute basal friction coefficient beta^2 and place in a_betaSqr More...

Static Public Member Functions
static BasalFriction *	parse (const char *a_prefix, const RealVect &a_domainSize)

Detailed Description

interface class encapsulating coefficient of basal friction (beta^2) for ice-sheet model This is a virtual base class – it is expected that specific cases will be derived from this

Constructor & Destructor Documentation

◆ ~BasalFriction()

virtual BasalFriction::~BasalFriction ( )

inlinevirtual

virtual destructor

References new_basalFriction(), parse(), and setBasalFriction().

Member Function Documentation

◆ new_basalFriction()

virtual BasalFriction* BasalFriction::new_basalFriction ( ) const

pure virtual

factory method

Returns: a pointer to a new BasalFriction object

Implemented in PythonInterface::PythonBasalFriction, sinusoidalFriction, MultiLevelDataBasalFriction, constantFriction, zeroFriction, LevelDataBasalFriction, singularStreamFriction, twistyStreamFriction, CopyBasalFriction, GaussianBumpFriction, and FortranInterfaceBasalFriction.

Referenced by AmrIce::setBasalFriction(), ~BasalFriction(), constantFriction::~constantFriction(), and zeroFriction::~zeroFriction().

◆ parse()

BasalFriction * BasalFriction::parse	(	const char *	a_prefix,
		const RealVect &	a_domainSize
	)

static

References readLevelData(), readMultiLevelData(), and sinusoidalFriction::sinusoidalFriction().

Referenced by init_bisicles_instance(), main(), and ~BasalFriction().

◆ setBasalFriction()

virtual void BasalFriction::setBasalFriction	(	LevelData< FArrayBox > &	a_betaSqr,
		LevelSigmaCS &	a_coordSys,
		Real	a_time,
		Real	a_dt
	)

pure virtual

compute basal friction coefficient beta^2 and place in a_betaSqr

time and dt are included in case this is time-dependent. Units should usually be chosen so that the basal traction $\tau_b(\beta^2, u)$ is measured in Pascals when $u $ is measured in meters per year.

Parameters

a_betaSqr	basal friction coefficient beta^2 data
a_coordSys	ice sheet geometry
a_time	current time
a_dt	current time step

Implemented in PythonInterface::PythonBasalFriction, sinusoidalFriction, MultiLevelDataBasalFriction, constantFriction, LevelDataBasalFriction, zeroFriction, singularStreamFriction, twistyStreamFriction, CopyBasalFriction, GaussianBumpFriction, and FortranInterfaceBasalFriction.