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

Public Member Functions

virtual std::pair< std::string, std::string > execute (TableHandler &statistics)
 
std::list< std::string > required_other_postprocessors () const
 
virtual void parse_parameters (ParameterHandler &prm)
 
double evaluate (const Point< dim > &) const
 
- Public Member Functions inherited from aspect::Postprocess::Interface< dim >
virtual ~Interface ()
 
virtual void initialize ()
 
virtual void update ()
 
virtual void save (std::map< std::string, std::string > &status_strings) const
 
virtual void load (const std::map< std::string, std::string > &status_strings)
 
- Public Member Functions inherited from aspect::SimulatorAccess< dim >
 SimulatorAccess ()
 
 SimulatorAccess (const Simulator< dim > &simulator_object)
 
virtual ~SimulatorAccess ()
 
virtual void initialize_simulator (const Simulator< dim > &simulator_object)
 
template<typename PostprocessorType >
PostprocessorType * find_postprocessor () const
 
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
 
TimerOutputget_computing_timer () const
 
const ConditionalOStreamget_pcout () const
 
double get_time () const
 
double get_timestep () const
 
double get_old_timestep () const
 
unsigned int get_timestep_number () 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
 
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
 
void compute_material_model_input_values (const LinearAlgebra::BlockVector &input_solution, const FEValuesBase< dim, dim > &input_finite_element_values, const typename DoFHandler< dim >::active_cell_iterator &cell, const bool compute_strainrate, MaterialModel::MaterialModelInputs< dim > &material_model_inputs) 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
 
DEAL_II_DEPRECATED const BoundaryTemperature::Interface< dim > & get_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
 
DEAL_II_DEPRECATED const BoundaryComposition::Interface< dim > & get_boundary_composition () const
 
const BoundaryComposition::Manager< dim > & get_boundary_composition_manager () const
 
const std::map< types::boundary_id, std::shared_ptr< BoundaryTraction::Interface< dim > > > & get_boundary_traction () const
 
DEAL_II_DEPRECATED const InitialTemperature::Interface< dim > & get_initial_temperature () const
 
const InitialTemperature::Manager< dim > & get_initial_temperature_manager () const
 
DEAL_II_DEPRECATED const InitialComposition::Interface< dim > & get_initial_composition () 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_free_surface_boundary_indicators () const
 
DEAL_II_DEPRECATED const std::map< types::boundary_id, std::shared_ptr< BoundaryVelocity::Interface< dim > > > get_prescribed_boundary_velocity () 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 NewtonHandler< dim > & get_newton_handler () const
 
const WorldBuilder::World & get_world_builder () const
 
const FreeSurfaceHandler< dim > & get_free_surface_handler () const
 
const LateralAveraging< dim > & get_lateral_averaging () const
 
const ConstraintMatrix & get_current_constraints () const
 
bool simulator_is_initialized () const
 
double get_pressure_scaling () const
 
bool pressure_rhs_needs_compatibility_modification () const
 
bool model_has_prescribed_stokes_solution () const
 
TableHandlerget_statistics_object () const
 
template<typename PostprocessorType >
DEAL_II_DEPRECATED PostprocessorType * find_postprocessor () const
 
const Postprocess::Manager< dim > & get_postprocess_manager () const
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 
- Static Public Member Functions inherited from aspect::Postprocess::Interface< dim >
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

std::pair< std::vector< double >, std::vector< double > > to_spherical_harmonic_coefficients (const std::vector< std::vector< double > > &spherical_function) const
 
std::pair< std::vector< double >, std::vector< double > > density_contribution (const double &outer_radius) const
 
std::pair< std::pair< double, std::pair< std::vector< double >, std::vector< double > > >, std::pair< double, std::pair< std::vector< double >, std::vector< double > > > > dynamic_topography_contribution (const double &outer_radius, const double &inner_radius) const
 

Private Attributes

unsigned int max_degree
 
unsigned int min_degree
 
bool output_in_lat_lon
 
bool also_output_geoid_anomaly_SH_coes
 
bool also_output_surface_dynamic_topo_contribution_SH_coes
 
bool also_output_CMB_dynamic_topo_contribution_SH_coes
 
bool also_output_density_anomaly_contribution_SH_coes
 
bool also_output_gravity_anomaly
 
double density_above
 
double density_below
 
std::vector< double > geoid_coecos
 
std::vector< double > geoid_coesin
 

Detailed Description

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

A postprocessor that computes the geoid anomaly at the surface.

Definition at line 39 of file geoid.h.

Member Function Documentation

§ execute()

template<int dim>
virtual std::pair<std::string,std::string> aspect::Postprocess::Geoid< dim >::execute ( TableHandler statistics)
virtual

Evaluate the solution for the geoid in spherical harmonics and then transfer it to grid output.

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

§ required_other_postprocessors()

template<int dim>
std::list<std::string> aspect::Postprocess::Geoid< dim >::required_other_postprocessors ( ) const
virtual

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

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

§ declare_parameters()

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

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>
virtual void aspect::Postprocess::Geoid< dim >::parse_parameters ( ParameterHandler prm)
virtual

Read the parameters this class declares from the parameter file.

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

§ evaluate()

template<int dim>
double aspect::Postprocess::Geoid< dim >::evaluate ( const Point< dim > &  ) const

Evaluate the geoid solution at a point. The evaluation point must be outside of the model domain, and it must be called after execute().

§ to_spherical_harmonic_coefficients()

template<int dim>
std::pair<std::vector<double>,std::vector<double> > aspect::Postprocess::Geoid< dim >::to_spherical_harmonic_coefficients ( const std::vector< std::vector< double > > &  spherical_function) const
private

Function to compute the real spherical harmonic coefficients (cos and sin part) from min degree to max degree The input spherical_function is a vector of vectors. The inner vector stores theta, phi, spherical infinitesimal, and function value on a spherical surface. The outer vector stores the inner vector associated with each quadrature point on a spherical surface.

§ density_contribution()

template<int dim>
std::pair<std::vector<double>,std::vector<double> > aspect::Postprocess::Geoid< dim >::density_contribution ( const double &  outer_radius) const
private

Function to compute the density contribution in spherical harmonic expansion throughout the mantle The input outer radius is needed to evaluate the density integral contribution of whole model domain at the surface This function returns a pair containing real spherical harmonics of density integral (cos and sin part) from min degree to max degree.

§ dynamic_topography_contribution()

template<int dim>
std::pair<std::pair<double, std::pair<std::vector<double>,std::vector<double> > >, std::pair<double, std::pair<std::vector<double>,std::vector<double> > > > aspect::Postprocess::Geoid< dim >::dynamic_topography_contribution ( const double &  outer_radius,
const double &  inner_radius 
) const
private

Function to compute the surface and CMB dynamic topography contribution in spherical harmonic expansion The input inner and outer radius are used to calculate spherical infinitesimal area, i.e., sin(theta)*d_theta*d_phi associated with each quadrature point on surface and bottom respectively. This function returns a pair containing surface and CMB dynamic topography's real spherical harmonic coefficients (cos and sin part) from min degree to max degree. The surface and CMB average density are also included as the first single element of each subpair respectively.

Member Data Documentation

§ max_degree

template<int dim>
unsigned int aspect::Postprocess::Geoid< dim >::max_degree
private

Parameters to set the maximum and minimum degree when computing geoid from spherical harmonics

Definition at line 82 of file geoid.h.

§ min_degree

template<int dim>
unsigned int aspect::Postprocess::Geoid< dim >::min_degree
private

Definition at line 83 of file geoid.h.

§ output_in_lat_lon

template<int dim>
bool aspect::Postprocess::Geoid< dim >::output_in_lat_lon
private

A parameter to control whether to output the data in geographical coordinates. If true, output the data in longitudes and latitudes; if false, output data in x y z.

Definition at line 89 of file geoid.h.

§ also_output_geoid_anomaly_SH_coes

template<int dim>
bool aspect::Postprocess::Geoid< dim >::also_output_geoid_anomaly_SH_coes
private

A parameter to control whether to output the spherical harmonic coefficients of the geoid anomaly

Definition at line 94 of file geoid.h.

§ also_output_surface_dynamic_topo_contribution_SH_coes

template<int dim>
bool aspect::Postprocess::Geoid< dim >::also_output_surface_dynamic_topo_contribution_SH_coes
private

A parameter to control whether to output the spherical harmonic coefficients of the surface dynamic topography contribution

Definition at line 99 of file geoid.h.

§ also_output_CMB_dynamic_topo_contribution_SH_coes

template<int dim>
bool aspect::Postprocess::Geoid< dim >::also_output_CMB_dynamic_topo_contribution_SH_coes
private

A parameter to control whether to output the spherical harmonic coefficients of the CMB dynamic topography contribution

Definition at line 104 of file geoid.h.

§ also_output_density_anomaly_contribution_SH_coes

template<int dim>
bool aspect::Postprocess::Geoid< dim >::also_output_density_anomaly_contribution_SH_coes
private

A parameter to control whether to output the spherical harmonic coefficients of the density anomaly

Definition at line 109 of file geoid.h.

§ also_output_gravity_anomaly

template<int dim>
bool aspect::Postprocess::Geoid< dim >::also_output_gravity_anomaly
private

A parameter to control whether to output the free-air gravity anomaly

Definition at line 114 of file geoid.h.

§ density_above

template<int dim>
double aspect::Postprocess::Geoid< dim >::density_above
private

Parameters to set the density value out of the surface and CMB boundary

Definition at line 119 of file geoid.h.

§ density_below

template<int dim>
double aspect::Postprocess::Geoid< dim >::density_below
private

Definition at line 120 of file geoid.h.

§ geoid_coecos

template<int dim>
std::vector<double> aspect::Postprocess::Geoid< dim >::geoid_coecos
private

A vector to store the cosine terms of the geoid anomaly spherical harmonic coefficients.

Definition at line 153 of file geoid.h.

§ geoid_coesin

template<int dim>
std::vector<double> aspect::Postprocess::Geoid< dim >::geoid_coesin
private

A vector to store the sine terms of the geoid anomaly spherical harmonic coefficients.

Definition at line 157 of file geoid.h.


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