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

PISM's SSA solver: the finite difference implementation. More...

#include <SSAFD.hh>

+ Inheritance diagram for pism::stressbalance::SSAFD:

Classes

class  KSPFailure
 
class  PicardFailure
 
struct  Work
 

Public Member Functions

 SSAFD (std::shared_ptr< const Grid > g)
 
virtual ~SSAFD ()=default
 
const array::Staggeredintegrated_viscosity () const
 
- Public Member Functions inherited from pism::stressbalance::SSA
 SSA (std::shared_ptr< const Grid > g)
 
virtual ~SSA ()
 
virtual void update (const Inputs &inputs, bool full_update)
 Update the SSA solution. More...
 
void set_initial_guess (const array::Vector &guess)
 Set the initial guess of the SSA velocity. More...
 
virtual std::string stdout_report () const
 Produce a report string for the standard output. More...
 
const array::Vectordriving_stress () const
 
- Public Member Functions inherited from pism::stressbalance::ShallowStressBalance
 ShallowStressBalance (std::shared_ptr< const Grid > g)
 
virtual ~ShallowStressBalance ()
 
void init ()
 
const array::Vector1velocity () const
 Get the thickness-advective 2D velocity. More...
 
const array::Scalarbasal_frictional_heating ()
 Get the basal frictional heating (for the adaptive energy time-stepping). More...
 
void compute_basal_frictional_heating (const array::Vector &velocity, const array::Scalar &tauc, const array::CellType &mask, array::Scalar &result) const
 Compute the basal frictional heating. More...
 
std::shared_ptr< const rheology::FlowLawflow_law () const
 
EnthalpyConverter::Ptr enthalpy_converter () const
 
const IceBasalResistancePlasticLawsliding_law () const
 
double flow_enhancement_factor () 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

virtual void init_impl ()
 Initialize a generic regular-grid SSA solver. More...
 
virtual DiagnosticList diagnostics_impl () const
 
virtual void pc_setup_bjacobi ()
 
virtual void pc_setup_asm ()
 
virtual void solve (const Inputs &inputs)
 Compute the vertically-averaged horizontal velocity from the shallow shelf approximation. More...
 
virtual void picard_iteration (const Inputs &inputs, double nuH_regularization, double nuH_iter_failure_underrelax)
 
virtual void picard_manager (const Inputs &inputs, double nuH_regularization, double nuH_iter_failure_underrelax)
 Manages the Picard iteration loop. More...
 
virtual void picard_strategy_regularization (const Inputs &inputs)
 Old SSAFD recovery strategy: increase the SSA regularization parameter. More...
 
virtual void compute_hardav_staggered (const Inputs &inputs)
 Computes vertically-averaged ice hardness on the staggered grid. More...
 
virtual void compute_nuH_staggered (const array::Scalar1 &ice_thickness, const array::Vector1 &velocity, const array::Staggered &hardness, double nuH_regularization, array::Staggered &result)
 Compute the product of ice thickness and effective viscosity (on the staggered grid). More...
 
virtual void compute_nuH_staggered_cfbc (const array::Scalar1 &ice_thickness, const array::CellType2 &mask, const array::Vector1 &velocity, const array::Staggered &hardness, double nuH_regularization, array::Staggered &result)
 Compute the product of ice viscosity and thickness on the staggered grid. Used when CFBC is enabled. More...
 
virtual void compute_nuH_norm (double &norm, double &norm_change)
 Compute the norm of nu H and the change in nu H. More...
 
virtual void assemble_matrix (const Inputs &inputs, bool include_basal_shear, Mat A)
 Assemble the left-hand side matrix for the KSP-based, Picard iteration, and finite difference implementation of the SSA equations. More...
 
virtual void assemble_rhs (const Inputs &inputs)
 Computes the right-hand side ("rhs") of the linear problem for the Picard iteration and finite-difference implementation of the SSA equations. More...
 
virtual void write_system_petsc (const std::string &namepart)
 
virtual void update_nuH_viewers ()
 Update the nuH viewer, which shows log10(nu H). More...
 
virtual bool is_marginal (int i, int j, bool ssa_dirichlet_bc)
 Checks if a cell is near or at the ice front. More...
 
virtual void fracture_induced_softening (const array::Scalar *fracture_density)
 Correct vertically-averaged hardness using a parameterization of the fracture-induced softening. More...
 
- Protected Member Functions inherited from pism::stressbalance::SSA
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 void compute_driving_stress (const array::Scalar &ice_thickness, const array::Scalar1 &surface_elevation, const array::CellType1 &cell_type, const array::Scalar1 *no_model_mask, array::Vector &result) const
 Compute the gravitational driving stress. More...
 
void extrapolate_velocity (const array::CellType1 &cell_type, array::Vector1 &velocity) const
 
- Protected Member Functions inherited from pism::Component
virtual MaxTimestep max_timestep_impl (double t) const
 
virtual TSDiagnosticList ts_diagnostics_impl () const
 
void regrid (const std::string &module_name, array::Array &variable, RegriddingFlag flag=NO_REGRID_WITHOUT_REGRID_VARS)
 

Protected Attributes

array::Staggered m_hardness
 
array::Staggered1 m_nuH
 
array::Staggered1 m_nuH_old
 
array::Array2D< Workm_work
 
petsc::KSP m_KSP
 
petsc::Mat m_A
 
array::Vector m_b
 
array::Vector1 m_velocity_old
 
const double m_scaling
 
unsigned int m_default_pc_failure_count
 
unsigned int m_default_pc_failure_max_count
 
bool m_view_nuh
 
std::shared_ptr< petsc::Viewerm_nuh_viewer
 
int m_nuh_viewer_size
 
- Protected Attributes inherited from pism::stressbalance::SSA
array::CellType2 m_mask
 
array::Vector m_taud
 
std::string m_stdout_ssa
 
std::shared_ptr< petsc::DMm_da
 
array::Vector m_velocity_global
 
int m_event_ssa
 
- Protected Attributes inherited from pism::stressbalance::ShallowStressBalance
IceBasalResistancePlasticLawm_basal_sliding_law
 
std::shared_ptr< rheology::FlowLawm_flow_law
 
EnthalpyConverter::Ptr m_EC
 
array::Vector2 m_velocity
 
array::Scalar m_basal_frictional_heating
 
double m_e_factor
 flow enhancement factor 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...
 

Additional Inherited Members

- Public Attributes inherited from pism::stressbalance::SSA
SSAStrengthExtensionstrength_extension
 
- 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...
 

Detailed Description

PISM's SSA solver: the finite difference implementation.

Definition at line 34 of file SSAFD.hh.


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