Inheritance diagram for aspect::TimeStepping::RepeatOnNonlinearFail< dim >:

Public Member Functions
	RepeatOnNonlinearFail ()

double	execute () override

void	nonlinear_solver_has_failed () const

std::pair< Reaction, double >	determine_reaction (const TimeStepInfo &info) override

void	parse_parameters (ParameterHandler &prm) override

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

virtual void	initialize ()

virtual void	update ()

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

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

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::Plugins::InterfaceBase
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
double	cut_back_factor

bool	nonlinear_solver_just_failed

unsigned int	maximum_number_of_repeats

unsigned int	current_number_of_repeats

Detailed Description

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

A class that implements a time stepping plugin to repeat a time step if the nonlinear solver failed to converge in the specified number of iterations. The timestep size will be reduced by the given amount specified by the user and hopefully results in the nonlinear solver converging. If necessary, the timestep size will be repeatedly reduced.

This class is automatically enabled if the user specifies that he/she wants to do this.

Definition at line 46 of file repeat_on_nonlinear_fail.h.

Constructor & Destructor Documentation

§ RepeatOnNonlinearFail()

template<int dim>

aspect::TimeStepping::RepeatOnNonlinearFail< dim >::RepeatOnNonlinearFail ( )

Constructor.

Member Function Documentation

§ execute()

template<int dim>

double aspect::TimeStepping::RepeatOnNonlinearFail< dim >::execute ( )

overridevirtual

Execute the logic of the plugin.

This is called after every time step to determine a) What to do (advance, repeat, etc.), see the Reaction enum. b) What timestep size to use.

Implements aspect::TimeStepping::Interface< dim >.

§ nonlinear_solver_has_failed()

template<int dim>

void aspect::TimeStepping::RepeatOnNonlinearFail< dim >::nonlinear_solver_has_failed ( ) const

This function notifies the plugin that the nonlinear solver failed.

§ determine_reaction()

template<int dim>

std::pair<Reaction, double> aspect::TimeStepping::RepeatOnNonlinearFail< dim >::determine_reaction ( const TimeStepInfo & info )

overridevirtual

The main execute() function.

Reimplemented from aspect::TimeStepping::Interface< dim >.

§ declare_parameters()

template<int dim>

static void aspect::TimeStepping::RepeatOnNonlinearFail< dim >::declare_parameters ( ParameterHandler & prm )

static

§ parse_parameters()

template<int dim>

void aspect::TimeStepping::RepeatOnNonlinearFail< dim >::parse_parameters ( ParameterHandler & prm )

overridevirtual

Read the parameters this class declares from the parameter file. The default implementation of this function does not read any parameters. Consequently, derived classes do not have to overload this function if they do not take any runtime parameters. On the other hand, most plugins do have run-time parameters, and they may then overload this function.

Reimplemented from aspect::Plugins::InterfaceBase.

Member Data Documentation

§ cut_back_factor

template<int dim>

double aspect::TimeStepping::RepeatOnNonlinearFail< dim >::cut_back_factor

private

Parameter to determine how much smaller the time step should be repeated as.

Definition at line 84 of file repeat_on_nonlinear_fail.h.

§ nonlinear_solver_just_failed

template<int dim>

bool aspect::TimeStepping::RepeatOnNonlinearFail< dim >::nonlinear_solver_just_failed

mutableprivate

Enabled by nonlinear_solver_has_failed() to signal that this plugin needs to act in the current timestep;

Definition at line 90 of file repeat_on_nonlinear_fail.h.

§ maximum_number_of_repeats

template<int dim>

unsigned int aspect::TimeStepping::RepeatOnNonlinearFail< dim >::maximum_number_of_repeats

private

How many times should we try cutting the timestep size before giving up?

Definition at line 95 of file repeat_on_nonlinear_fail.h.

§ current_number_of_repeats

template<int dim>

unsigned int aspect::TimeStepping::RepeatOnNonlinearFail< dim >::current_number_of_repeats

private

How many times have we been repeating already in this timestep?

Definition at line 100 of file repeat_on_nonlinear_fail.h.

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

/home/bob/source/include/aspect/time_stepping/repeat_on_nonlinear_fail.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

§ RepeatOnNonlinearFail()

Member Function Documentation

§ execute()

§ nonlinear_solver_has_failed()

§ determine_reaction()

§ declare_parameters()

§ parse_parameters()

Member Data Documentation

§ cut_back_factor

§ nonlinear_solver_just_failed

§ maximum_number_of_repeats

§ current_number_of_repeats

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