Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
aspect::TerminationCriteria::Manager< dim > Class Template Reference
Inheritance diagram for aspect::TerminationCriteria::Manager< dim >:
Inheritance graph

Public Member Functions

virtual bool execute () const
double check_for_last_time_step (const double time_step) const
void parse_parameters (ParameterHandler &prm)
 DeclException1 (ExcTerminationCriteriaNameNotFound, std::string,<< "Could not find entry <"<< arg1<< "> among the names of registered termination criteria 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::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
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_termination_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 Attributes

std::list< std::unique_ptr< Interface< dim > > > termination_objects
std::list< std::string > termination_obj_names

Detailed Description

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

A class that manages all objects that provide functionality to specify termination criteria.

Definition at line 155 of file interface.h.

Member Function Documentation

§ execute()

template<int dim>
virtual bool aspect::TerminationCriteria::Manager< dim >::execute ( ) const

Execute all of the termination criteria objects that have been requested in the input file.

The function returns a bool indicating whether the simulation should be terminated.

To avoid undefined situations, this function only requires that a single processor's termination request comes back positive for a given plugin. In other words, for each plugin selected, not all processors need to return the same value: if only one of the says that the simulation should be terminated, then this is enough.

§ check_for_last_time_step()

template<int dim>
double aspect::TerminationCriteria::Manager< dim >::check_for_last_time_step ( const double  time_step) const

Check all of the termination criteria objects that have been requested in the input file for criteria regarding last time step and if so get the minimum of these values.

Reduced or current time step size
A reduced time step size may be returned for the last time step. For all other time steps, the current time step size (provided as argument) will be returned. The returned time step size will be greater than zero, and less than or equal to the given argument put into this function.

§ declare_parameters()

template<int dim>
static void aspect::TerminationCriteria::Manager< dim >::declare_parameters ( ParameterHandler &  prm)

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

§ parse_parameters()

template<int dim>
void aspect::TerminationCriteria::Manager< dim >::parse_parameters ( ParameterHandler &  prm)

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

§ register_termination_criterion()

template<int dim>
static void aspect::TerminationCriteria::Manager< dim >::register_termination_criterion ( const std::string &  name,
const std::string &  description,
void(*)(ParameterHandler &)  declare_parameters_function,
std::unique_ptr< Interface< dim >>(*)()  factory_function 

A function that is used to register termination criteria 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 implement to register these plugins, rather than also having to modify the Manager class by adding the new termination criteria class.

nameThe name under which this plugin is to be called in parameter files.
descriptionA text description of what this model does and that will be listed in the documentation of the parameter file.
declare_parameters_functionA pointer to a function that declares the parameters for this plugin.
factory_functionA pointer to a function that creates such a termination criterion object and returns a pointer to it.

§ write_plugin_graph()

template<int dim>
static void aspect::TerminationCriteria::Manager< dim >::write_plugin_graph ( std::ostream &  output_stream)

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.

output_streamThe stream to write the output to.

§ DeclException1()

template<int dim>
aspect::TerminationCriteria::Manager< dim >::DeclException1 ( ExcTerminationCriteriaNameNotFound  ,


Member Data Documentation

§ termination_objects

template<int dim>
std::list<std::unique_ptr<Interface<dim> > > aspect::TerminationCriteria::Manager< dim >::termination_objects

A list of termination criterion objects that have been requested in the parameter file.

Definition at line 256 of file interface.h.

§ termination_obj_names

template<int dim>
std::list<std::string> aspect::TerminationCriteria::Manager< dim >::termination_obj_names

A list of names corresponding to the termination criteria in the termination_objects.

Definition at line 262 of file interface.h.

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