Inheritance diagram for aspect::MeshRefinement::Manager< dim >:

Public Member Functions
	~Manager () override

virtual void	update ()

virtual void	execute (Vector< float > &error_indicators) const

virtual void	tag_additional_cells () const

void	parse_parameters (ParameterHandler &prm)

template<typename MeshRefinementType , typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,MeshRefinementType>::value>>
bool	has_matching_mesh_refinement_strategy () const

template<typename MeshRefinementType , typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,MeshRefinementType>::value>>
const MeshRefinementType &	get_matching_mesh_refinement_strategy () const

	DeclException1 (ExcMeshRefinementNameNotFound, std::string,<< "Could not find entry <"<< arg1<< "> among the names of registered mesh refinement objects.")

Public Member Functions inherited from aspect::SimulatorAccess< dim >
	SimulatorAccess ()

	SimulatorAccess (const Simulator< dim > &simulator_object)

virtual	~SimulatorAccess ()=default

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

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 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 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_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

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 void	register_mesh_refinement_criterion (const std::string &name, const std::string &description, void(declare_parameters_function)(ParameterHandler &), std::unique_ptr< Interface< dim >>(factory_function)())

static void	write_plugin_graph (std::ostream &output_stream)

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 Types
enum	MergeOperation { plus, max }

Private Attributes
MergeOperation	merge_operation

bool	normalize_criteria

std::vector< double >	scaling_factors

std::list< std::unique_ptr< Interface< dim > > >	mesh_refinement_objects

Detailed Description

template<int dim>
class aspect::MeshRefinement::Manager< dim >

A class that manages all objects that provide functionality to refine meshes.

Definition at line 116 of file simulator_access.h.

Member Enumeration Documentation

§ MergeOperation

template<int dim>

enum aspect::MeshRefinement::Manager::MergeOperation

private

An enum that describes the different ways in which we can merge the results of multiple mesh refinement criteria.

Enumerator
plus
max

Definition at line 304 of file interface.h.

Constructor & Destructor Documentation

§ ~Manager()

template<int dim>

aspect::MeshRefinement::Manager< dim >::~Manager ( )

override

Destructor. Made virtual since this class has virtual member functions.

Member Function Documentation

§ update()

template<int dim>

virtual void aspect::MeshRefinement::Manager< dim >::update ( )

virtual

Update all of the mesh refinement objects that have been requested in the input file. Individual mesh refinement objects may choose to implement an update function to modify object variables once per time step.

§ execute()

template<int dim>

virtual void aspect::MeshRefinement::Manager< dim >::execute ( Vector< float > & error_indicators ) const

virtual

Execute all of the mesh refinement objects that have been requested in the input file. The error indicators are then each individually normalized and merged according to the operation specified in the input file (e.g., via a plus, a maximum operation, etc).

§ tag_additional_cells()

template<int dim>

virtual void aspect::MeshRefinement::Manager< dim >::tag_additional_cells ( ) const

virtual

Apply additional refinement criteria independent of the error estimate for all of the mesh refinement objects that have been requested in the input file.

§ declare_parameters()

template<int dim>

static void aspect::MeshRefinement::Manager< dim >::declare_parameters ( ParameterHandler & prm )

static

Declare the parameters of all known mesh refinement plugins, as well as of ones this class has itself.

§ parse_parameters()

template<int dim>

void aspect::MeshRefinement::Manager< dim >::parse_parameters ( ParameterHandler & prm )

Read the parameters this class declares from the parameter file. This determines which mesh refinement objects will be created; then let these objects read their parameters as well.

§ has_matching_mesh_refinement_strategy()

template<int dim>

template<typename MeshRefinementType , typename >

bool aspect::MeshRefinement::Manager< dim >::has_matching_mesh_refinement_strategy ( ) const

inline

Go through the list of all mesh refinement strategies that have been selected in the input file (and are consequently currently active) and return true if one of them has the desired type specified by the template argument.

This function can only be called if the given template type (the first template argument) is a class derived from the Interface class in this namespace.

Definition at line 337 of file interface.h.

§ get_matching_mesh_refinement_strategy()

template<int dim>

template<typename MeshRefinementType , typename >

const MeshRefinementType & aspect::MeshRefinement::Manager< dim >::get_matching_mesh_refinement_strategy ( ) const

inline

Go through the list of all mesh refinement strategies that have been selected in the input file (and are consequently currently active) and see if one of them has the type specified by the template argument or can be casted to that type. If so, return a reference to it. If no mesh refinement strategy is active that matches the given type, throw an exception.

This function can only be called if the given template type (the first template argument) is a class derived from the Interface class in this namespace.

Definition at line 354 of file interface.h.

§ register_mesh_refinement_criterion()

template<int dim>

static void aspect::MeshRefinement::Manager< dim >::register_mesh_refinement_criterion	(	const std::string &	name,
		const std::string &	description,
		void(*)(ParameterHandler &)	declare_parameters_function,
		std::unique_ptr< Interface< dim >>(*)()	factory_function
	)

static

A function that is used to register mesh refinement objects in such a way that the Manager can deal with all of them without having to know them by name. This allows the files in which individual plugins are implemented to register these plugins, rather than also having to modify the Manager class by adding the new mesh refinement class.

Parameters

name	The name under which this plugin is to be called in parameter files.
description	A text description of what this model does and that will be listed in the documentation of the parameter file.
declare_parameters_function	A pointer to a function that declares the parameters for this plugin.
factory_function	A pointer to a function that creates such a mesh refinement object and returns a pointer to it.

§ write_plugin_graph()

template<int dim>

static void aspect::MeshRefinement::Manager< dim >::write_plugin_graph ( std::ostream & output_stream )

static

For the current plugin subsystem, write a connection graph of all of the plugins we know about, in the format that the programs dot and neato understand. This allows for a visualization of how all of the plugins that ASPECT knows about are interconnected, and connect to other parts of the ASPECT code.

Parameters

output_stream The stream to write the output to.

§ DeclException1()

template<int dim>

aspect::MeshRefinement::Manager< dim >::DeclException1	(	ExcMeshRefinementNameNotFound	,
		std::string
	)

Exception.

Member Data Documentation

§ merge_operation

template<int dim>

MergeOperation aspect::MeshRefinement::Manager< dim >::merge_operation

private

How to merge the results of multiple mesh refinement criteria.

Definition at line 310 of file interface.h.

§ normalize_criteria

template<int dim>

bool aspect::MeshRefinement::Manager< dim >::normalize_criteria

private

Whether to normalize the individual refinement indicators to the range \([0,1]\) before merging.

Definition at line 316 of file interface.h.

§ scaling_factors

template<int dim>

std::vector<double> aspect::MeshRefinement::Manager< dim >::scaling_factors

private

The scaling factors that should be applied to the individual refinement indicators before merging.

Definition at line 322 of file interface.h.

§ mesh_refinement_objects

template<int dim>

std::list<std::unique_ptr<Interface<dim> > > aspect::MeshRefinement::Manager< dim >::mesh_refinement_objects

private

A list of mesh refinement objects that have been requested in the parameter file.

Definition at line 328 of file interface.h.

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

/home/bob/source/include/aspect/simulator_access.h
/home/bob/source/include/aspect/mesh_refinement/interface.h

Public Member Functions

Static Public Member Functions

Private Types

Private Attributes

Detailed Description

template<int dim> class aspect::MeshRefinement::Manager< dim >

Member Enumeration Documentation

§ MergeOperation

Constructor & Destructor Documentation

§ ~Manager()

Member Function Documentation

§ update()

§ execute()

§ tag_additional_cells()

§ declare_parameters()

§ parse_parameters()

§ has_matching_mesh_refinement_strategy()

§ get_matching_mesh_refinement_strategy()

§ register_mesh_refinement_criterion()

§ write_plugin_graph()

§ DeclException1()

Member Data Documentation

§ merge_operation

§ normalize_criteria

§ scaling_factors

§ mesh_refinement_objects

template<int dim>
class aspect::MeshRefinement::Manager< dim >