PISM, A Parallel Ice Sheet Model  stable v2.1-1-g6902d5502 committed by Ed Bueler on 2023-12-20 08:38:27 -0800
Public Member Functions | Protected Member Functions | List of all members
pism::energy::BTU_Minimal Class Reference

#include <BTU_Minimal.hh>

+ Inheritance diagram for pism::energy::BTU_Minimal:

Public Member Functions

 BTU_Minimal (std::shared_ptr< const Grid > g)
 
- Public Member Functions inherited from pism::energy::BedThermalUnit
 BedThermalUnit (std::shared_ptr< const Grid > g)
 
virtual ~BedThermalUnit ()=default
 
void init (const InputOptions &opts)
 
const array::Scalarflux_through_top_surface () const
 Return the upward heat flux through the top surface of the bedrock thermal layer. More...
 
const array::Scalarflux_through_bottom_surface () const
 Return the upward heat flux through the bottom surface of the bedrock thermal layer. More...
 
void update (const array::Scalar &bedrock_top_temperature, double t, double dt)
 
double vertical_spacing () const
 
double depth () const
 
unsigned int Mz () const
 
- Public Member Functions inherited from pism::Component
 Component (std::shared_ptr< const Grid > grid)
 
virtual ~Component ()=default
 
DiagnosticList diagnostics () const
 
TSDiagnosticList ts_diagnostics () const
 
std::shared_ptr< const Gridgrid () const
 
const Timetime () const
 
const Profilingprofiling () const
 
void define_model_state (const File &output) const
 Define model state variables in an output file. More...
 
void write_model_state (const File &output) const
 Write model state variables to an output file. More...
 
MaxTimestep max_timestep (double t) const
 Reports the maximum time-step the model can take at time t. More...
 

Protected Member Functions

void init_impl (const InputOptions &opts)
 Initialize the bedrock thermal unit. More...
 
double vertical_spacing_impl () const
 
double depth_impl () const
 
unsigned int Mz_impl () const
 
MaxTimestep max_timestep_impl (double t) const
 
void update_impl (const array::Scalar &bedrock_top_temperature, double t, double dt)
 
virtual void update_impl (const array::Scalar &bedrock_top_temperature, double t, double dt)=0
 
- Protected Member Functions inherited from pism::energy::BedThermalUnit
virtual void initialize_bottom_surface_flux ()
 
virtual void define_model_state_impl (const File &output) const
 The default (empty implementation). More...
 
virtual void write_model_state_impl (const File &output) const
 The default (empty implementation). More...
 
virtual DiagnosticList diagnostics_impl () const
 
- Protected Member Functions inherited from pism::Component
virtual TSDiagnosticList ts_diagnostics_impl () const
 
void regrid (const std::string &module_name, array::Array &variable, RegriddingFlag flag=NO_REGRID_WITHOUT_REGRID_VARS)
 

Additional Inherited Members

- Public Types inherited from pism::energy::BedThermalUnit
typedef std::shared_ptr< BedThermalUnitPtr
 
typedef std::shared_ptr< const BedThermalUnitConstPtr
 
- Static Public Member Functions inherited from pism::energy::BedThermalUnit
static std::shared_ptr< BedThermalUnitFromOptions (std::shared_ptr< const Grid > g, std::shared_ptr< const Context > ctx)
 
- Protected Types inherited from pism::Component
enum  RegriddingFlag { REGRID_WITHOUT_REGRID_VARS , NO_REGRID_WITHOUT_REGRID_VARS }
 This flag determines whether a variable is read from the -regrid_file file even if it is not listed among variables in -regrid_vars. More...
 
- Protected Attributes inherited from pism::energy::BedThermalUnit
array::Scalar m_bottom_surface_flux
 upward heat flux through the bottom surface of the bed thermal layer More...
 
array::Scalar m_top_surface_flux
 upward heat flux through the top surface of the bed thermal layer More...
 
- Protected Attributes inherited from pism::Component
const std::shared_ptr< const Gridm_grid
 grid used by this component More...
 
const Config::ConstPtr m_config
 configuration database used by this component More...
 
const units::System::Ptr m_sys
 unit system used by this component More...
 
const Logger::ConstPtr m_log
 logger (for easy access) More...
 

Detailed Description

Definition at line 28 of file BTU_Minimal.hh.


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