Inheritance diagram for aspect::AdiabaticConditions::Interface< dim >:

[legend]

Public Member Functions
	~Interface () override

virtual void	initialize ()

virtual bool	is_initialized () const =0

virtual void	update ()

virtual double	temperature (const Point< dim > &p) const =0

virtual double	pressure (const Point< dim > &p) const =0

virtual double	density (const Point< dim > &p) const =0

virtual double	density_derivative (const Point< dim > &p) const =0

virtual void	get_adiabatic_temperature_profile (std::vector< double > &values) const

virtual void	get_adiabatic_pressure_profile (std::vector< double > &values) const

virtual void	get_adiabatic_density_profile (std::vector< double > &values) const

virtual void	get_adiabatic_density_derivative_profile (std::vector< double > &values) const

virtual void	parse_parameters (ParameterHandler &prm)

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)

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

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

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

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

TableHandler &	get_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 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)

Detailed Description

template<int dim>
class aspect::AdiabaticConditions::Interface< dim >

Base class for classes that describe adiabatic conditions, i.e. that starts at the top of the domain and integrate pressure and temperature as we go down into depth. There are several ways to do this (time- dependent or constant, using laterally averaged values or a reference profile), therefore we allow for user written plugins.

Definition at line 120 of file simulator_access.h.

Constructor & Destructor Documentation

§ ~Interface()

template<int dim>

aspect::AdiabaticConditions::Interface< dim >::~Interface ( )

override

Destructor. Made virtual to enforce that derived classes also have virtual destructors.

Member Function Documentation

§ initialize()

template<int dim>

virtual void aspect::AdiabaticConditions::Interface< dim >::initialize ( )

virtual

Initialization function. This function is called once at the beginning of the program after parse_parameters is run and after the SimulatorAccess (if applicable) is initialized.

Reimplemented in aspect::AdiabaticConditions::ComputeProfile< dim >, aspect::AdiabaticConditions::AsciiData< dim >, and aspect::AdiabaticConditions::Function< dim >.

§ is_initialized()

template<int dim>

virtual bool aspect::AdiabaticConditions::Interface< dim >::is_initialized ( ) const

pure virtual

Some plugins need to know whether the adiabatic conditions are already calculated. Namely all plugins that are needed to create the adiabatic conditions but themselves depend on the adiabatic profile. Utilizing this function they may behave differently on initialization of the adiabatic conditions and at model runtime.

Implemented in aspect::AdiabaticConditions::ComputeProfile< dim >, aspect::AdiabaticConditions::AsciiData< dim >, and aspect::AdiabaticConditions::Function< dim >.

§ update()

template<int dim>

virtual void aspect::AdiabaticConditions::Interface< dim >::update ( )

virtual

Compute the adiabatic conditions along a vertical transect of the geometry based on the given material model and other quantities. This function is called at every new timestep.

Reimplemented in aspect::AdiabaticConditions::ComputeProfile< dim >.

§ temperature()

template<int dim>

virtual double aspect::AdiabaticConditions::Interface< dim >::temperature ( const Point< dim > & p ) const

pure virtual

Return the adiabatic temperature at a given point of the domain.

Implemented in aspect::AdiabaticConditions::ComputeProfile< dim >, aspect::AdiabaticConditions::AsciiData< dim >, and aspect::AdiabaticConditions::Function< dim >.

§ pressure()

template<int dim>

virtual double aspect::AdiabaticConditions::Interface< dim >::pressure ( const Point< dim > & p ) const

pure virtual

Return the adiabatic pressure at a given point of the domain.

Implemented in aspect::AdiabaticConditions::ComputeProfile< dim >, aspect::AdiabaticConditions::AsciiData< dim >, and aspect::AdiabaticConditions::Function< dim >.

§ density()

template<int dim>

virtual double aspect::AdiabaticConditions::Interface< dim >::density ( const Point< dim > & p ) const

pure virtual

Return the reference_density at a given point of the domain.

Implemented in aspect::AdiabaticConditions::ComputeProfile< dim >, aspect::AdiabaticConditions::AsciiData< dim >, and aspect::AdiabaticConditions::Function< dim >.

§ density_derivative()

template<int dim>

virtual double aspect::AdiabaticConditions::Interface< dim >::density_derivative ( const Point< dim > & p ) const

pure virtual

Return the derivative of the density with respect to depth at the given point p.

Implemented in aspect::AdiabaticConditions::ComputeProfile< dim >, aspect::AdiabaticConditions::AsciiData< dim >, and aspect::AdiabaticConditions::Function< dim >.

§ get_adiabatic_temperature_profile()

template<int dim>

virtual void aspect::AdiabaticConditions::Interface< dim >::get_adiabatic_temperature_profile ( std::vector< double > & values ) const

virtual

Return the adiabatic temperature profile as a vector of values corresponding to increasing depth.

Parameters

values The output vector of depth averaged values. The function takes the pre-existing size of this vector as the number of depth slices.

§ get_adiabatic_pressure_profile()

template<int dim>

virtual void aspect::AdiabaticConditions::Interface< dim >::get_adiabatic_pressure_profile ( std::vector< double > & values ) const

virtual

Like get_adiabatic_temperature_profile() but for the pressure.

§ get_adiabatic_density_profile()

template<int dim>

virtual void aspect::AdiabaticConditions::Interface< dim >::get_adiabatic_density_profile ( std::vector< double > & values ) const

virtual

Like get_adiabatic_temperature_profile() but for the density.

§ get_adiabatic_density_derivative_profile()

template<int dim>

virtual void aspect::AdiabaticConditions::Interface< dim >::get_adiabatic_density_derivative_profile ( std::vector< double > & values ) const

virtual

Like get_adiabatic_temperature_profile() but for the density derivative.

§ declare_parameters()

template<int dim>

static void aspect::AdiabaticConditions::Interface< dim >::declare_parameters ( ParameterHandler & prm )

static

Declare the parameters this class takes through input files. The default implementation of this function does not describe any parameters. Consequently, derived classes do not have to overload this function if they do not take any runtime parameters.

§ parse_parameters()

template<int dim>

virtual void aspect::AdiabaticConditions::Interface< dim >::parse_parameters ( ParameterHandler & prm )

virtual

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.

Reimplemented in aspect::AdiabaticConditions::ComputeProfile< dim >, aspect::AdiabaticConditions::AsciiData< dim >, and aspect::AdiabaticConditions::Function< dim >.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

template<int dim> class aspect::AdiabaticConditions::Interface< dim >

Constructor & Destructor Documentation

§ ~Interface()

Member Function Documentation

§ initialize()

§ is_initialized()

§ update()

§ temperature()

§ pressure()

§ density()

§ density_derivative()

§ get_adiabatic_temperature_profile()

§ get_adiabatic_pressure_profile()

§ get_adiabatic_density_profile()

§ get_adiabatic_density_derivative_profile()

§ declare_parameters()

§ parse_parameters()

template<int dim>
class aspect::AdiabaticConditions::Interface< dim >