Inheritance diagram for aspect::Postprocess::VisualizationPostprocessors::BoundaryVelocityResidual< dim >:

[legend]

Public Member Functions
	BoundaryVelocityResidual ()

void	evaluate_vector_field (const DataPostprocessorInputs::Vector< dim > &input_data, std::vector< Vector< double >> &computed_quantities) const override

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

std::string	get_physical_units () const override

Public Member Functions inherited from DataPostprocessorVector< dim >
	DataPostprocessorVector (const std::string &name, const UpdateFlags update_flags)

virtual std::vector< std::string >	get_names () const override

virtual std::vector< DataComponentInterpretation::DataComponentInterpretation >	get_data_component_interpretation () const override

virtual UpdateFlags	get_needed_update_flags () const override

virtual void	evaluate_scalar_field (const DataPostprocessorInputs::Scalar< dim > &input_data, std::vector< Vector< double > > &computed_quantities) const

virtual void	evaluate_vector_field (const DataPostprocessorInputs::Vector< dim > &input_data, std::vector< Vector< double > > &computed_quantities) const

void	serialize (Archive &ar, const unsigned int version)

unsigned int	n_subscriptions () const

unsigned int	n_subscriptions () const

void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

Public Member Functions inherited from DataPostprocessor< int dim >
virtual	~DataPostprocessor () override=default

void	serialize (Archive &ar, const unsigned int version)

unsigned int	n_subscriptions () const

void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

unsigned int	n_subscriptions () const

void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

Public Member Functions inherited from EnableObserverPointer
	EnableObserverPointer ()

	EnableObserverPointer (const EnableObserverPointer &)

	EnableObserverPointer (EnableObserverPointer &&) noexcept

virtual	~EnableObserverPointer ()

EnableObserverPointer &	operator= (const EnableObserverPointer &)

EnableObserverPointer &	operator= (EnableObserverPointer &&) noexcept

void	serialize (Archive &ar, const unsigned int version)

unsigned int	n_subscriptions () const

void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

unsigned int	n_subscriptions () const

void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

Public Member Functions inherited from aspect::Postprocess::VisualizationPostprocessors::SurfaceOnlyVisualization< dim >
virtual	~SurfaceOnlyVisualization ()=default

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

Public Member Functions inherited from aspect::Postprocess::VisualizationPostprocessors::Interface< dim >
	Interface (const std::string &physical_units="")

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

virtual void	initialize ()

virtual void	update ()

virtual void	parse_parameters (ParameterHandler &prm)

virtual void	save (std::map< std::string, std::string > &status_strings) const

virtual void	load (const std::map< std::string, std::string > &status_strings)

Additional Inherited Members
Static Public Member Functions inherited from DataPostprocessorVector< dim >
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Static Public Member Functions inherited from DataPostprocessor< int dim >
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Static Public Member Functions inherited from EnableObserverPointer
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

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)

Static Public Member Functions inherited from aspect::Plugins::InterfaceBase
static void	declare_parameters (ParameterHandler &prm)

Detailed Description

template<int dim>
class aspect::Postprocess::VisualizationPostprocessors::BoundaryVelocityResidual< dim >

A class derived from DataPostprocessor that takes an output vector and computes a variable that represents the velocity residual between the input velocity data and the velocity computed for the model domain. The input velocity could either be an ascii data file or a file generated by the GPlates model. This quantity only makes sense at the surface of the domain. Thus, the value is set to zero in all the cells inside of the domain.

The member functions are all implementations of those declared in the base class. See there for their meaning.

Definition at line 51 of file boundary_velocity_residual.h.

Constructor & Destructor Documentation

◆ BoundaryVelocityResidual()

template<int dim>

aspect::Postprocess::VisualizationPostprocessors::BoundaryVelocityResidual< dim >::BoundaryVelocityResidual ( )

Member Function Documentation

◆ evaluate_vector_field()

template<int dim>

void aspect::Postprocess::VisualizationPostprocessors::BoundaryVelocityResidual< dim >::evaluate_vector_field	(	const DataPostprocessorInputs::Vector< dim > &	input_data,
		std::vector< Vector< double >> &	computed_quantities
	)		const

override

Evaluate the velocity residual for the current cell.

◆ required_other_postprocessors()

template<int dim>

std::list<std::string> aspect::Postprocess::VisualizationPostprocessors::BoundaryVelocityResidual< dim >::required_other_postprocessors ( ) const

overridevirtual

Let the postprocessor manager know about the other postprocessors this one depends on. Specifically, the boundary velocity residual statistics postprocessor.

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

◆ get_physical_units()

template<int dim>

std::string aspect::Postprocess::VisualizationPostprocessors::BoundaryVelocityResidual< dim >::get_physical_units ( ) const

overridevirtual

Return the string representation of the physical units that a derived class has provided to the constructor of this class.

As mentioned in the documentation of the constructor, there are cases where a derived class doesn't know the physical units yet that correspond to what is being output at the time the constructor is called. In that case, the derived class can overload this function and return the correct units when the visualization postprocessor is executed.

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

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/visualization/boundary_velocity_residual.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<int dim> class aspect::Postprocess::VisualizationPostprocessors::BoundaryVelocityResidual< dim >

Constructor & Destructor Documentation

◆ BoundaryVelocityResidual()

Member Function Documentation

◆ evaluate_vector_field()

◆ required_other_postprocessors()

◆ get_physical_units()

template<int dim>
class aspect::Postprocess::VisualizationPostprocessors::BoundaryVelocityResidual< dim >