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

Public Member Functions

virtual void initialize_simulator (const Simulator< dim > &simulator_object) override
 
void update ()
 
double get_next_time_step_size () const
 
bool should_repeat_time_step () const
 
bool should_refine_mesh () const
 
bool need_checkpoint_on_terminate () const
 
bool should_simulation_terminate_now () const
 
void parse_parameters (ParameterHandler &prm)
 
- Public Member Functions inherited from aspect::SimulatorAccess< dim >
 SimulatorAccess ()
 
 SimulatorAccess (const Simulator< dim > &simulator_object)
 
virtual ~SimulatorAccess ()
 
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 void write_plugin_graph (std::ostream &output_stream)
 
static void register_time_stepping_model (const std::string &name, const std::string &description, void(*declare_parameters_function)(ParameterHandler &), Interface< dim > *(*factory_function)())
 
- 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

Reaction current_reaction
 
double next_time_step_size
 
double minimum_time_step_size
 
bool do_checkpoint_on_terminate
 
TerminationCriteria::Manager< dim > termination_manager
 
std::list< std::unique_ptr< Interface< dim > > > active_plugins
 

Detailed Description

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

A class to handle computation of the next time step (as desired by the user) and checking if the simulation is finished.

Definition at line 175 of file interface.h.

Member Function Documentation

§ initialize_simulator()

template<int dim>
virtual void aspect::TimeStepping::Manager< dim >::initialize_simulator ( const Simulator< dim > &  simulator_object)
overridevirtual

Override initialize_simulator() so that we can also initialize the contained termination_manager.

Reimplemented from aspect::SimulatorAccess< dim >.

§ update()

template<int dim>
void aspect::TimeStepping::Manager< dim >::update ( )

Update the current state and determine what needs to happen based on the last computed solution (see functions below). This computes the size of the next time step potentially taking into account the current solution (convection time step, conduction time step), settings from parameters, and termination criteria (to hit the end time exactly).

§ get_next_time_step_size()

template<int dim>
double aspect::TimeStepping::Manager< dim >::get_next_time_step_size ( ) const

Return the next step size as computed from update().

§ should_repeat_time_step()

template<int dim>
bool aspect::TimeStepping::Manager< dim >::should_repeat_time_step ( ) const

If true, a plugin requested to redo the last computed time step. Updated when calling update().

§ should_refine_mesh()

template<int dim>
bool aspect::TimeStepping::Manager< dim >::should_refine_mesh ( ) const

If true, execute a mesh refinement step now (potentially before repeating the current time step).

§ need_checkpoint_on_terminate()

template<int dim>
bool aspect::TimeStepping::Manager< dim >::need_checkpoint_on_terminate ( ) const

If true, the simulator should perform a checkpoint before terminating.

§ should_simulation_terminate_now()

template<int dim>
bool aspect::TimeStepping::Manager< dim >::should_simulation_terminate_now ( ) const

Check if the simulation is ready to terminate successfully.

§ declare_parameters()

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

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::TimeStepping::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.

§ write_plugin_graph()

template<int dim>
static void aspect::TimeStepping::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_streamThe stream to write the output to.

§ register_time_stepping_model()

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

A function that is used to register time stepping model 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 plugin class.

Parameters
nameA string that identifies the model
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 can be used to declare the parameters that this model wants to read from input files.
factory_functionA pointer to a function that can create an object of this model.

Member Data Documentation

§ current_reaction

template<int dim>
Reaction aspect::TimeStepping::Manager< dim >::current_reaction
private

The current Reaction computed by update().

Definition at line 281 of file interface.h.

§ next_time_step_size

template<int dim>
double aspect::TimeStepping::Manager< dim >::next_time_step_size
private

The next time step size computed by update().

Definition at line 286 of file interface.h.

§ minimum_time_step_size

template<int dim>
double aspect::TimeStepping::Manager< dim >::minimum_time_step_size
private

The minimum time step size specified by the user (in seconds).

Definition at line 291 of file interface.h.

§ do_checkpoint_on_terminate

template<int dim>
bool aspect::TimeStepping::Manager< dim >::do_checkpoint_on_terminate
private

Whether to do a final checkpoint before termination. This is specified in the parameters.

Definition at line 297 of file interface.h.

§ termination_manager

template<int dim>
TerminationCriteria::Manager<dim> aspect::TimeStepping::Manager< dim >::termination_manager
private

The termination manager keeps track of the termination plugins and we use it to determine the time_step size in the final time step.

Definition at line 303 of file interface.h.

§ active_plugins

template<int dim>
std::list<std::unique_ptr<Interface<dim> > > aspect::TimeStepping::Manager< dim >::active_plugins
private

A list of active plugins to determine time step sizes.

Definition at line 308 of file interface.h.


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