ASPECT
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
aspect::Postprocess::SeaLevel< dim > Class Template Reference
Inheritance diagram for aspect::Postprocess::SeaLevel< dim >:
Inheritance graph
[legend]

Public Member Functions

void initialize () override
 
std::pair< std::string, std::string > execute (TableHandler &statistics) override
 
double compute_total_surface_pressure (const Point< dim > &position) const
 
std::list< std::string > required_other_postprocessors () const override
 
void parse_parameters (ParameterHandler &prm) override
 
void save (std::map< std::string, std::string > &status_strings) const override
 
void load (const std::map< std::string, std::string > &status_strings) override
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
- Public Member Functions inherited from aspect::Plugins::InterfaceBase
virtual ~InterfaceBase ()=default
 
virtual void update ()
 
- Public Member Functions inherited from aspect::SimulatorAccess< dim >
 SimulatorAccess ()
 
 SimulatorAccess (const Simulator< dim > &simulator_object)
 
virtual ~SimulatorAccess ()=default
 
virtual void initialize_simulator (const Simulator< dim > &simulator_object)
 
const Introspection< dim > & introspection () const
 
const Simulator< dim > & get_simulator () const
 
const Parameters< dim > & get_parameters () const
 
SimulatorSignals< dim > & get_signals () const
 
MPI_Comm get_mpi_communicator () const
 
TimerOutput & get_computing_timer () const
 
const ConditionalOStream & get_pcout () const
 
double get_time () const
 
double get_timestep () const
 
double get_old_timestep () const
 
unsigned int get_timestep_number () const
 
const TimeStepping::Manager< dim > & get_timestepping_manager () const
 
unsigned int get_nonlinear_iteration () const
 
const parallel::distributed::Triangulation< dim > & get_triangulation () const
 
double get_volume () const
 
const Mapping< dim > & get_mapping () const
 
std::string get_output_directory () const
 
bool include_adiabatic_heating () const
 
bool include_latent_heat () const
 
bool include_melt_transport () const
 
int get_stokes_velocity_degree () const
 
double get_adiabatic_surface_temperature () const
 
double get_surface_pressure () const
 
bool convert_output_to_years () const
 
unsigned int get_pre_refinement_step () const
 
unsigned int n_compositional_fields () const
 
double get_end_time () const
 
void get_refinement_criteria (Vector< float > &estimated_error_per_cell) const
 
void get_artificial_viscosity (Vector< float > &viscosity_per_cell, const bool skip_interior_cells=false) const
 
void get_artificial_viscosity_composition (Vector< float > &viscosity_per_cell, const unsigned int compositional_variable) const
 
const LinearAlgebra::BlockVectorget_current_linearization_point () const
 
const LinearAlgebra::BlockVectorget_solution () const
 
const LinearAlgebra::BlockVectorget_old_solution () const
 
const LinearAlgebra::BlockVectorget_old_old_solution () const
 
const LinearAlgebra::BlockVectorget_reaction_vector () const
 
const LinearAlgebra::BlockVectorget_mesh_velocity () const
 
const DoFHandler< dim > & get_dof_handler () const
 
const FiniteElement< dim > & get_fe () const
 
const LinearAlgebra::BlockSparseMatrixget_system_matrix () const
 
const LinearAlgebra::BlockSparseMatrixget_system_preconditioner_matrix () const
 
const MaterialModel::Interface< dim > & get_material_model () const
 
const GravityModel::Interface< dim > & get_gravity_model () const
 
const InitialTopographyModel::Interface< dim > & get_initial_topography_model () const
 
const GeometryModel::Interface< dim > & get_geometry_model () const
 
const AdiabaticConditions::Interface< dim > & get_adiabatic_conditions () const
 
bool has_boundary_temperature () const
 
const BoundaryTemperature::Manager< dim > & get_boundary_temperature_manager () const
 
const BoundaryHeatFlux::Interface< dim > & get_boundary_heat_flux () const
 
bool has_boundary_composition () const
 
const BoundaryComposition::Manager< dim > & get_boundary_composition_manager () const
 
const BoundaryTraction::Manager< dim > & get_boundary_traction_manager () const
 
std::shared_ptr< const InitialTemperature::Manager< dim > > get_initial_temperature_manager_pointer () const
 
const InitialTemperature::Manager< dim > & get_initial_temperature_manager () const
 
std::shared_ptr< const InitialComposition::Manager< dim > > get_initial_composition_manager_pointer () const
 
const InitialComposition::Manager< dim > & get_initial_composition_manager () const
 
const std::set< types::boundary_id > & get_fixed_temperature_boundary_indicators () const
 
const std::set< types::boundary_id > & get_fixed_heat_flux_boundary_indicators () const
 
const std::set< types::boundary_id > & get_fixed_composition_boundary_indicators () const
 
const std::set< types::boundary_id > & get_mesh_deformation_boundary_indicators () const
 
const BoundaryVelocity::Manager< dim > & get_boundary_velocity_manager () const
 
const HeatingModel::Manager< dim > & get_heating_model_manager () const
 
const MeshRefinement::Manager< dim > & get_mesh_refinement_manager () const
 
const MeltHandler< dim > & get_melt_handler () const
 
const VolumeOfFluidHandler< dim > & get_volume_of_fluid_handler () const
 
const NewtonHandler< dim > & get_newton_handler () const
 
const MeshDeformation::MeshDeformationHandler< dim > & get_mesh_deformation_handler () const
 
const LateralAveraging< dim > & get_lateral_averaging () const
 
const AffineConstraints< double > & get_current_constraints () const
 
bool simulator_is_past_initialization () const
 
double get_pressure_scaling () const
 
bool pressure_rhs_needs_compatibility_modification () const
 
bool model_has_prescribed_stokes_solution () const
 
TableHandler & get_statistics_object () const
 
const Postprocess::Manager< dim > & get_postprocess_manager () const
 
unsigned int n_particle_managers () const
 
const Particle::Manager< dim > & get_particle_manager (const unsigned int particle_manager_index) const
 
Particle::Manager< dim > & get_particle_manager (const unsigned int particle_manager_index)
 
bool is_stokes_matrix_free ()
 
const StokesMatrixFreeHandler< dim > & get_stokes_matrix_free () const
 
RotationProperties< dim > compute_net_angular_momentum (const bool use_constant_density, const LinearAlgebra::BlockVector &solution, const bool limit_to_top_faces=false) const
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 
- Static Public Member Functions inherited from aspect::Plugins::InterfaceBase
static void declare_parameters (ParameterHandler &prm)
 
- Static Public Member Functions inherited from aspect::SimulatorAccess< dim >
static void get_composition_values_at_q_point (const std::vector< std::vector< double >> &composition_values, const unsigned int q, std::vector< double > &composition_values_at_q_point)
 

Private Member Functions

double compute_nonuniform_sea_level_change (const Point< dim > &position) const
 
double compute_sea_level_offset ()
 

Private Attributes

std::string data_directory_topography
 
std::string data_file_name_topography
 
std::string data_directory_ice_height
 
std::string data_file_name_ice_height
 
std::unique_ptr< Utilities::StructuredDataLookup< 2 > > topography_lookup
 
std::unique_ptr< Utilities::StructuredDataLookup< 2 > > ice_height_lookup
 
double density_water
 
double density_ice
 
double sea_level_offset
 
bool write_to_file
 
double output_interval
 
double last_output_time
 

Detailed Description

template<int dim>
class aspect::Postprocess::SeaLevel< dim >

A postprocessor that outputs the sea level to file. The sea level is based on the ice heights input data, the solid Earth topography input data for defining the ocean basin, the geoid displacement from the geoid postprocessor, and the free surface topography from the geometry model. The sea level postprocessor requires a 3D spherical shell geometry with a free surface. The sea level computation is based on \cite{Martinec2018}.

Definition at line 45 of file sea_level.h.

Member Function Documentation

§ initialize()

template<int dim>
void aspect::Postprocess::SeaLevel< dim >::initialize ( )
overridevirtual

Sets up structured data lookup for topography and ice height input data.

Reimplemented from aspect::Plugins::InterfaceBase.

§ execute()

template<int dim>
std::pair<std::string,std::string> aspect::Postprocess::SeaLevel< dim >::execute ( TableHandler &  statistics)
overridevirtual

Output non-uniform sea level change [m] to file.

Implements aspect::Postprocess::Interface< dim >.

§ compute_total_surface_pressure()

template<int dim>
double aspect::Postprocess::SeaLevel< dim >::compute_total_surface_pressure ( const Point< dim > &  position) const

Evaluate the total surface pressure from ice and water loading at a point at the top surface of the domain. While the function will return pressure values for any location, it will always assume the volume between the point and the sea level is filled with water or ice, therefore calling this function for positions inside the domain will result in unrealistic pressure values.

§ required_other_postprocessors()

template<int dim>
std::list<std::string> aspect::Postprocess::SeaLevel< dim >::required_other_postprocessors ( ) const
overridevirtual

Register with the simulator the other postprocessors that we need (namely: geoid).

Reimplemented from aspect::Postprocess::Interface< dim >.

§ declare_parameters()

template<int dim>
static void aspect::Postprocess::SeaLevel< dim >::declare_parameters ( ParameterHandler &  prm)
static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>
void aspect::Postprocess::SeaLevel< dim >::parse_parameters ( ParameterHandler &  prm)
overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

§ save()

template<int dim>
void aspect::Postprocess::SeaLevel< dim >::save ( std::map< std::string, std::string > &  status_strings) const
overridevirtual

Save the state of this object.

Reimplemented from aspect::Postprocess::Interface< dim >.

§ load()

template<int dim>
void aspect::Postprocess::SeaLevel< dim >::load ( const std::map< std::string, std::string > &  status_strings)
overridevirtual

Restore the state of the object.

Reimplemented from aspect::Postprocess::Interface< dim >.

§ serialize()

template<int dim>
template<class Archive >
void aspect::Postprocess::SeaLevel< dim >::serialize ( Archive &  ar,
const unsigned int  version 
)

Serialize the contents of this class as far as they are not read from input parameter files.

§ compute_nonuniform_sea_level_change()

template<int dim>
double aspect::Postprocess::SeaLevel< dim >::compute_nonuniform_sea_level_change ( const Point< dim > &  position) const
private

Function to determine non-uniform sea level change for any given location. This is a local computation that makes use of the computed sea level offset, so make sure to call compute_sea_level_offset() before calling this function.

§ compute_sea_level_offset()

template<int dim>
double aspect::Postprocess::SeaLevel< dim >::compute_sea_level_offset ( )
private

Function to determine the global sea level offset.

Member Data Documentation

§ data_directory_topography

template<int dim>
std::string aspect::Postprocess::SeaLevel< dim >::data_directory_topography
private

Information about the location of topography data files.

Definition at line 125 of file sea_level.h.

§ data_file_name_topography

template<int dim>
std::string aspect::Postprocess::SeaLevel< dim >::data_file_name_topography
private

Definition at line 126 of file sea_level.h.

§ data_directory_ice_height

template<int dim>
std::string aspect::Postprocess::SeaLevel< dim >::data_directory_ice_height
private

Information about the location of ice height data files.

Definition at line 131 of file sea_level.h.

§ data_file_name_ice_height

template<int dim>
std::string aspect::Postprocess::SeaLevel< dim >::data_file_name_ice_height
private

Definition at line 132 of file sea_level.h.

§ topography_lookup

template<int dim>
std::unique_ptr<Utilities::StructuredDataLookup<2> > aspect::Postprocess::SeaLevel< dim >::topography_lookup
private

Pointer to the StructuredDataLookup object that holds the topography and ice height data.

Definition at line 137 of file sea_level.h.

§ ice_height_lookup

template<int dim>
std::unique_ptr<Utilities::StructuredDataLookup<2> > aspect::Postprocess::SeaLevel< dim >::ice_height_lookup
private

Definition at line 138 of file sea_level.h.

§ density_water

template<int dim>
double aspect::Postprocess::SeaLevel< dim >::density_water
private

The density of water.

Definition at line 143 of file sea_level.h.

§ density_ice

template<int dim>
double aspect::Postprocess::SeaLevel< dim >::density_ice
private

The density of ice.

Definition at line 148 of file sea_level.h.

§ sea_level_offset

template<int dim>
double aspect::Postprocess::SeaLevel< dim >::sea_level_offset
private

The global sea level offset.

Definition at line 153 of file sea_level.h.

§ write_to_file

template<int dim>
bool aspect::Postprocess::SeaLevel< dim >::write_to_file
private

Whether or not to produce text files with sea level values.

Definition at line 158 of file sea_level.h.

§ output_interval

template<int dim>
double aspect::Postprocess::SeaLevel< dim >::output_interval
private

Interval between the generation of text output. This parameter is read from the input file and consequently is not part of the state that needs to be saved and restored.

Definition at line 165 of file sea_level.h.

§ last_output_time

template<int dim>
double aspect::Postprocess::SeaLevel< dim >::last_output_time
private

A time (in seconds) at which the last text output was supposed to be produced. Used to check for the next necessary output time.

Definition at line 171 of file sea_level.h.


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