ASPECT
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
aspect::Postprocess::BoundaryVelocityResidualStatistics< dim > Class Template Reference
Inheritance diagram for aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >:
Inheritance graph
[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 ~Interface ()
 
virtual void update ()
 
virtual std::list< std::string > required_other_postprocessors () const
 
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::unique_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_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
 
TableHandlerget_statistics_object () const
 
template<typename PostprocessorType >
DEAL_II_DEPRECATED PostprocessorType * find_postprocessor () const
 
const Postprocess::Manager< dim > & get_postprocess_manager () const
 
const Particle::World< dim > & get_particle_world () const
 
Particle::World< dim > & get_particle_world ()
 
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::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 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::Postprocess::Interface< dim >.

§ 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::Postprocess::Interface< dim >.

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.

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

Definition at line 91 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 96 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 101 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.

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

Definition at line 114 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 in output instead of seconds" parameter).

Definition at line 122 of file boundary_velocity_residual_statistics.h.


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