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

[legend]

Public Member Functions
void	initialize () override

Tensor< 1, dim >	get_data_velocity (const Point< dim > &p) const

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

void	parse_parameters (ParameterHandler &prm) override

Public Member Functions inherited from aspect::Postprocess::Interface< dim >
virtual std::list< std::string >	required_other_postprocessors () 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 Attributes
bool	use_spherical_unit_vectors

bool	use_ascii_data

std::unique_ptr< BoundaryVelocity::internal::GPlatesLookup< dim > >	gplates_lookup

std::unique_ptr< Utilities::StructuredDataLookup< dim > >	data_lookup

std::string	data_directory

std::string	data_file_name

double	scale_factor

Detailed Description

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

A postprocessor that computes some statistics about the velocity residual at the top surface. The velocity residual is calculated as the difference between the modeled velocities and input data velocities (GPlates model or ascii data).

Definition at line 44 of file boundary_velocity_residual_statistics.h.

Member Function Documentation

◆ initialize()

template<int dim>

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

overridevirtual

This function reads the specified input velocity data files, i.e., either an ascii data file or a file from the GPlates model.

Reimplemented from aspect::Plugins::InterfaceBase.

◆ get_data_velocity()

template<int dim>

Tensor<1,dim> aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >::get_data_velocity ( const Point< dim > & p ) const

This function returns the input data velocity, (GPlates model or ascii data) value at a point. This function is called from execute() function.

◆ execute()

template<int dim>

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

overridevirtual

Evaluate the solution statistics for some velocity residual at the top boundary.

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

◆ declare_parameters()

template<int dim>

static void aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >::declare_parameters ( ParameterHandler & prm )

static

Declare the parameters this class takes through input files.

◆ parse_parameters()

template<int dim>

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

overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

Member Data Documentation

◆ use_spherical_unit_vectors

template<int dim>

bool aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >::use_spherical_unit_vectors

private

Determines if the input ascii data file has velocity components in spherical, i.e., (r, phi, theta) or in cartesian, i.e., (x, y, z) coordinate system.

This variable is read from the parameter file through a parameter called 'Use spherical unit vectors'.

Definition at line 87 of file boundary_velocity_residual_statistics.h.

◆ use_ascii_data

template<int dim>

bool aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >::use_ascii_data

private

Determines if the model velocities are compared against ascii data files, or a gplates model. This variable is read from the parameter file through a parameter called 'Use ascii data'.

Definition at line 94 of file boundary_velocity_residual_statistics.h.

◆ gplates_lookup

template<int dim>

std::unique_ptr<BoundaryVelocity::internal::GPlatesLookup<dim> > aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >::gplates_lookup

private

Pointer to the gplates boundary velocity model

Definition at line 99 of file boundary_velocity_residual_statistics.h.

◆ data_lookup

template<int dim>

std::unique_ptr<Utilities::StructuredDataLookup<dim> > aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >::data_lookup

private

Pointer to the structured data

Definition at line 104 of file boundary_velocity_residual_statistics.h.

◆ data_directory

template<int dim>

std::string aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >::data_directory

private

Directory in which the input data files, i.e., GPlates model or ascii data are present. This variable is read from the parameter file through a parameter called 'Data directory'.

Definition at line 111 of file boundary_velocity_residual_statistics.h.

◆ data_file_name

template<int dim>

std::string aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >::data_file_name

private

Filename of the input Gplates model or ascii data file. For GPlates, the file names can contain the specifiers s and/or c (in this order), meaning the name of the boundary and the number of the data file time step. This variable is read from the parameter file through a parameter called 'Data file name'.

Definition at line 119 of file boundary_velocity_residual_statistics.h.

◆ scale_factor

template<int dim>

double aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >::scale_factor

private

Scale the input data by a scalar factor. Can be used to transform the unit of the data (if they are not specified in SI units (m/s or m/yr depending on the "Use years instead of seconds" parameter).

This variable is read from the parameter file through a parameter called 'Scale factor'.

Definition at line 129 of file boundary_velocity_residual_statistics.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/boundary_velocity_residual_statistics.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

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

Member Function Documentation

◆ initialize()

◆ get_data_velocity()

◆ execute()

◆ declare_parameters()

◆ parse_parameters()

Member Data Documentation

◆ use_spherical_unit_vectors

◆ use_ascii_data

◆ gplates_lookup

◆ data_lookup

◆ data_directory

◆ data_file_name

◆ scale_factor

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