BISICLES AMR ice sheet model: constantFriction Class Reference

BISICLES AMR ice sheet model 0.9

BasalFriction where $\beta^2$ is constant in space and time. More...

#include <BasalFriction.H>

Inheritance diagram for constantFriction:

Inheritance graph

[legend]

Collaboration diagram for constantFriction:

Collaboration graph

[legend]

Public Member Functions
	constantFriction ()

	constantFriction (Real a_betaSqr)
	Construct a constant friction with a known value. More...

	~constantFriction ()

BasalFriction *	new_basalFriction () const
	factory method More...

void	setBasalFriction (LevelData< FArrayBox > &a_betaSqr, LevelSigmaCS &a_coordSys, Real a_time, Real a_dt)
	define source term for thickness evolution and place it in flux More...

void	setFrictionVal (const Real &a_betaSqr)
	Change the constanst basal friction coefficient. More...

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

Protected Attributes
Real	m_frictionVal

bool	m_isValSet

Additional Inherited Members
Static Public Member Functions inherited from BasalFriction
static BasalFriction *	parse (const char *a_prefix, const RealVect &a_domainSize)

Detailed Description

BasalFriction where $\beta^2$ is constant in space and time.

Run time configuration is carried out in BasalFriction::parse(A, ... ) If the option A.beta_type == constantBeta is found, then the expected form is:

A.betaValue = <float>

Constructor & Destructor Documentation

◆ constantFriction() [1/2]

constantFriction::constantFriction ( )

Referenced by new_basalFriction().

◆ constantFriction() [2/2]

constantFriction::constantFriction ( Real a_betaSqr )

Construct a constant friction with a known value.

Parameters

a_value basal friction coefficient

◆ ~constantFriction()

constantFriction::~constantFriction ( )

inline

References BasalFriction::new_basalFriction(), and BasalFriction::setBasalFriction().

Member Function Documentation

◆ new_basalFriction()

BasalFriction * constantFriction::new_basalFriction ( ) const

virtual

factory method

Returns: a pointer to a new BasalFriction object

Implements BasalFriction.

References constantFriction(), m_frictionVal, and m_isValSet.

◆ setBasalFriction()

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

virtual

define source term for thickness evolution and place it in flux

dt is included in case one needs integrals or averages over a timestep

Implements BasalFriction.

References m_frictionVal, and m_isValSet.

◆ setFrictionVal()

void constantFriction::setFrictionVal ( const Real & a_betaSqr )

Change the constanst basal friction coefficient.

Parameters

a_betaSqr basal friction coefficient

References m_frictionVal, and m_isValSet.

Member Data Documentation

◆ m_frictionVal

Real constantFriction::m_frictionVal

protected

Referenced by new_basalFriction(), setBasalFriction(), and setFrictionVal().

◆ m_isValSet

bool constantFriction::m_isValSet

protected

Referenced by new_basalFriction(), setBasalFriction(), and setFrictionVal().

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