Inheritance diagram for aspect::Postprocess::Geoid< dim >:

[legend]

Public Member Functions
std::pair< std::string, std::string >	execute (TableHandler &statistics) override

std::list< std::string >	required_other_postprocessors () const override

void	parse_parameters (ParameterHandler &prm) override

void	initialize () override

double	evaluate (const Point< dim > &) const

Public Member Functions inherited from aspect::Plugins::InterfaceBase
virtual	~InterfaceBase ()=default

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)

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

unsigned int	get_checkpoint_id () 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::BlockVector &	get_current_linearization_point () const

const LinearAlgebra::BlockVector &	get_solution () const

const LinearAlgebra::BlockVector &	get_old_solution () const

const LinearAlgebra::BlockVector &	get_old_old_solution () const

const LinearAlgebra::BlockVector &	get_reaction_vector () const

const LinearAlgebra::BlockVector &	get_mesh_velocity () const

const DoFHandler< dim > &	get_dof_handler () const

const FiniteElement< dim > &	get_fe () const

const LinearAlgebra::BlockSparseMatrix &	get_system_matrix () const

const LinearAlgebra::BlockSparseMatrix &	get_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 std::shared_ptr< const InitialTopographyModel::Interface< dim > >	get_initial_topography_model_pointer () 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 BoundaryConvectiveHeating::Manager< dim > &	get_boundary_convective_heating_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_convective_heating_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

const PrescribedSolution::Manager< dim > &	get_prescribed_solution () const

RotationProperties< dim >	compute_net_angular_momentum (const bool use_constant_density, const LinearAlgebra::BlockVector &solution, const bool limit_to_top_faces=false) const

void	remove_nullspace (LinearAlgebra::BlockVector &solution, LinearAlgebra::BlockVector &distributed_stokes_solution) const

double	normalize_pressure (LinearAlgebra::BlockVector &vector) const

void	denormalize_pressure (const double pressure_adjustment, LinearAlgebra::BlockVector &vector) 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
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 > > > >	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	output_geoid_anomaly_SH_coes

bool	output_surface_topo_contribution_SH_coes

bool	output_CMB_topo_contribution_SH_coes

bool	output_density_anomaly_contribution_SH_coes

bool	output_gravity_anomaly

double	density_above

double	density_below

bool	include_surface_topo_contribution

bool	include_CMB_topo_contribution

bool	use_free_surface_topography

bool	use_free_CMB_topography

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>

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

overridevirtual

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

overridevirtual

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>

void aspect::Postprocess::Geoid< dim >::parse_parameters ( ParameterHandler & prm )

overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

◆ initialize()

template<int dim>

void aspect::Postprocess::Geoid< dim >::initialize ( )

overridevirtual

Find if the top or bottom boundaries are free surfaces.

Reimplemented from aspect::Plugins::InterfaceBase.

◆ 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.

◆ 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 >::topography_contribution	(	const double &	outer_radius,
		const double &	inner_radius
	)		const

private

Function to compute the surface and CMB 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 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. The topography is based on the dynamic topography postprocessor in case of no free surface, and based on the real surface from the geometry model in case of a free surface.

Member Data Documentation

◆ max_degree

template<int dim>

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

private

Maximum degree when computing geoid from spherical harmonics.

This variable is read from the parameter file through a parameter called 'Maximum degree'.

Definition at line 87 of file geoid.h.

◆ min_degree

template<int dim>

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

private

Minimum degree when computing geoid from spherical harmonics. This variable is read from the parameter file through a parameter called 'Minimum degree'.

Definition at line 93 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. This variable is read from the parameter file through a parameter called 'Output data in geographical coordinates'.

Definition at line 100 of file geoid.h.

◆ output_geoid_anomaly_SH_coes

template<int dim>

bool aspect::Postprocess::Geoid< dim >::output_geoid_anomaly_SH_coes

private

A parameter to control whether to output the spherical harmonic coefficients of the geoid anomaly This variable is read from the parameter file through a parameter called 'Output geoid anomaly coefficients'.

Definition at line 106 of file geoid.h.

◆ output_surface_topo_contribution_SH_coes

template<int dim>

bool aspect::Postprocess::Geoid< dim >::output_surface_topo_contribution_SH_coes

private

A parameter to control whether to output the spherical harmonic coefficients of the surface topography contribution This variable is read from the parameter file through a parameter called 'Output surface topography contribution coefficients'.

Definition at line 112 of file geoid.h.

◆ output_CMB_topo_contribution_SH_coes

template<int dim>

bool aspect::Postprocess::Geoid< dim >::output_CMB_topo_contribution_SH_coes

private

A parameter to control whether to output the spherical harmonic coefficients of the CMB topography contribution This variable is read from the parameter file through a parameter called 'Output CMB topography contribution coefficients'.

Definition at line 118 of file geoid.h.

◆ output_density_anomaly_contribution_SH_coes

template<int dim>

bool aspect::Postprocess::Geoid< dim >::output_density_anomaly_contribution_SH_coes

private

A parameter to control whether to output the spherical harmonic coefficients of the density anomaly This variable is read from the parameter file through a parameter called 'Output density anomaly contribution coefficients'.

Definition at line 124 of file geoid.h.

◆ output_gravity_anomaly

template<int dim>

bool aspect::Postprocess::Geoid< dim >::output_gravity_anomaly

private

A parameter to control whether to output the free-air gravity anomaly This variable is read from the parameter file through a parameter called 'Output gravity anomaly'.

Definition at line 130 of file geoid.h.

◆ density_above

template<int dim>

double aspect::Postprocess::Geoid< dim >::density_above

private

Density value outside the surface boundary. This variable is read from the parameter file through a parameter called 'Density above'.

Definition at line 136 of file geoid.h.

◆ density_below

template<int dim>

double aspect::Postprocess::Geoid< dim >::density_below

private

Density value outside the CMB boundary. This variable is read from the parameter file through a parameter called 'Density below'.

Definition at line 142 of file geoid.h.

◆ include_surface_topo_contribution

template<int dim>

bool aspect::Postprocess::Geoid< dim >::include_surface_topo_contribution

private

A parameter to control whether to include the surface topography contribution on geoid This variable is read from the parameter file through a parameter called 'Include surface topography contribution'.

Definition at line 148 of file geoid.h.

◆ include_CMB_topo_contribution

template<int dim>

bool aspect::Postprocess::Geoid< dim >::include_CMB_topo_contribution

private

A parameter to control whether to include the CMB topography contribution on geoid

This variable is read from the parameter file through a parameter called 'Include CMB topography contribution'.

Definition at line 155 of file geoid.h.

◆ use_free_surface_topography

template<int dim>

bool aspect::Postprocess::Geoid< dim >::use_free_surface_topography

private

A parameter to specify if the top boundary is an active free surface

Definition at line 160 of file geoid.h.

◆ use_free_CMB_topography

template<int dim>

bool aspect::Postprocess::Geoid< dim >::use_free_CMB_topography

private

A parameter to specify if the bottom boundary is an active free surface

Definition at line 165 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.

These coefficients are computed afresh by execute() and are subsequently accessed through evaluate(), for example by the sea level postprocessor. Consequently, they do not need to be serialized for checkpoint/restart: execute() recomputes them before dependent postprocessors use them.

Definition at line 205 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.

See geoid_coecos for why these runtime values are not serialized.

Definition at line 212 of file geoid.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/aspect-documentation/checkouts/latest/include/aspect/postprocess/geoid.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

Member Function Documentation

◆ execute()

◆ required_other_postprocessors()

◆ declare_parameters()

◆ parse_parameters()

◆ initialize()

◆ evaluate()

◆ to_spherical_harmonic_coefficients()

◆ density_contribution()

◆ topography_contribution()

Member Data Documentation

◆ max_degree

◆ min_degree

◆ output_in_lat_lon

◆ output_geoid_anomaly_SH_coes

◆ output_surface_topo_contribution_SH_coes

◆ output_CMB_topo_contribution_SH_coes

◆ output_density_anomaly_contribution_SH_coes

◆ output_gravity_anomaly

◆ density_above

◆ density_below

◆ include_surface_topo_contribution

◆ include_CMB_topo_contribution

◆ use_free_surface_topography

◆ use_free_CMB_topography

◆ geoid_coecos

◆ geoid_coesin

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