Inheritance diagram for aspect::TerminationCriteria::SteadyHeatFlux< dim >:

[legend]

Public Member Functions
bool	execute () override

void	parse_parameters (ParameterHandler &prm) override

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

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

Public Member Functions inherited from aspect::TerminationCriteria::Interface< dim >
virtual double	check_for_last_time_step (const double time_step) const

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 ()

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

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	necessary_time_in_steady_state

double	allowed_relative_deviation

std::set< types::boundary_id >	boundary_indicators

std::list< std::pair< double, double > >	time_heat_flux

Detailed Description

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

A class that implements a termination criterion based on the steady state of the average heat flux.

Definition at line 40 of file steady_heat_flux.h.

Member Function Documentation

◆ execute()

template<int dim>

bool aspect::TerminationCriteria::SteadyHeatFlux< dim >::execute ( )

overridevirtual

Evaluate this termination criterion.

Returns: Whether to terminate the simulation (true) or continue (false).

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

◆ declare_parameters()

template<int dim>

static void aspect::TerminationCriteria::SteadyHeatFlux< dim >::declare_parameters ( ParameterHandler & prm )

static

Declare the parameters this class takes through input files.

◆ parse_parameters()

template<int dim>

void aspect::TerminationCriteria::SteadyHeatFlux< dim >::parse_parameters ( ParameterHandler & prm )

overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

◆ save()

template<int dim>

void aspect::TerminationCriteria::SteadyHeatFlux< dim >::save ( std::map< std::string, std::string > & status_strings ) const

overridevirtual

Save the state of this object to the argument given to this function. This function is in support of checkpoint/restart functionality.

Derived classes can implement this function and should store their state in a string that is deposited under a key in the map through which the respective class can later find the status again when the program is restarted. A legitimate key to store data under is typeid(*this).name(). It is up to derived classes to decide how they want to encode their state.

The default implementation of this function does nothing, i.e., it represents a stateless object for which nothing needs to be stored at checkpoint time and nothing needs to be restored at restart time.

Parameters

[in,out] status_strings The object into which implementations in derived classes can place their status under a key that they can use to retrieve the data.

Reimplemented from aspect::Plugins::InterfaceBase.

◆ load()

template<int dim>

void aspect::TerminationCriteria::SteadyHeatFlux< dim >::load ( const std::map< std::string, std::string > & status_strings )

overridevirtual

Restore the state of the object by looking up a description of the state in the passed argument under the same key under which it was previously stored.

The default implementation does nothing.

Parameters

[in] status_strings The object from which the status will be restored by looking up the value for a key specific to this derived class.

Reimplemented from aspect::Plugins::InterfaceBase.

Member Data Documentation

◆ necessary_time_in_steady_state

template<int dim>

double aspect::TerminationCriteria::SteadyHeatFlux< dim >::necessary_time_in_steady_state

private

The minimum length of simulation time that the system should be in steady state before termination.

This variable is read from the parameter file through a parameter called 'Time in steady state'.

Definition at line 79 of file steady_heat_flux.h.

◆ allowed_relative_deviation

template<int dim>

double aspect::TerminationCriteria::SteadyHeatFlux< dim >::allowed_relative_deviation

private

The maximum relative deviation of the heat flux in recent simulation time for the system to be considered in steady state. This variable is read from the parameter file through a parameter called 'Maximum relative deviation'.

Definition at line 87 of file steady_heat_flux.h.

◆ boundary_indicators

template<int dim>

std::set<types::boundary_id> aspect::TerminationCriteria::SteadyHeatFlux< dim >::boundary_indicators

private

A set of boundary ids on which the average heat flux will be computed.

This variable is read from the parameter file through a parameter called 'Boundary indicators'.

Definition at line 96 of file steady_heat_flux.h.

◆ time_heat_flux

template<int dim>

std::list<std::pair<double, double> > aspect::TerminationCriteria::SteadyHeatFlux< dim >::time_heat_flux

private

A list of pairs (time, heat flux) that we have computed at previous time steps. This is used to determine when we have reached steady state.

Definition at line 103 of file steady_heat_flux.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/aspect-documentation/checkouts/latest/include/aspect/termination_criteria/steady_heat_flux.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

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

Member Function Documentation

◆ execute()

◆ declare_parameters()

◆ parse_parameters()

◆ save()

◆ load()

Member Data Documentation

◆ necessary_time_in_steady_state

◆ allowed_relative_deviation

◆ boundary_indicators

◆ time_heat_flux

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