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

Public Member Functions

 ComputeProfile ()
 
virtual void initialize ()
 
virtual void update ()
 
virtual bool is_initialized () const
 
virtual double temperature (const Point< dim > &p) const
 
virtual double pressure (const Point< dim > &p) const
 
virtual double density (const Point< dim > &p) const
 
virtual double density_derivative (const Point< dim > &p) const
 
virtual void parse_parameters (ParameterHandler &prm)
 
- Public Member Functions inherited from aspect::AdiabaticConditions::Interface< dim >
virtual ~Interface ()
 
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
 
- 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)
 
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_free_surface_boundary_indicators () const
 
DEAL_II_DEPRECATED const std::map< types::boundary_id, std::shared_ptr< BoundaryVelocity::Interface< dim > > > get_prescribed_boundary_velocity () 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 WorldBuilder::World & get_world_builder () const
 
const FreeSurfaceHandler< dim > & get_free_surface_handler () const
 
const LateralAveraging< dim > & get_lateral_averaging () const
 
const ConstraintMatrix & get_current_constraints () const
 
bool simulator_is_initialized () 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
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 
- Static Public Member Functions inherited from aspect::AdiabaticConditions::Interface< dim >
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 Types

enum  CompositionProfile { initial_composition, reference_function }
 

Private Member Functions

double get_property (const Point< dim > &p, const std::vector< double > &property) const
 

Private Attributes

bool initialized
 
unsigned int n_points
 
std::vector< double > temperatures
 
std::vector< double > pressures
 
std::vector< double > densities
 
double delta_z
 
CompositionProfile reference_composition
 
std::unique_ptr< Functions::ParsedFunction< 1 > > composition_function
 
bool use_surface_condition_function
 
Functions::ParsedFunction< 1 > surface_condition_function
 

Detailed Description

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

A model in which the adiabatic profile is calculated by solving the hydrostatic equations for pressure and temperature in depth. The gravity is assumed to be in depth direction and the composition is either given by the initial composition at reference points or computed as a reference depth-function. All material parameters are computed by the material model plugin. The surface conditions are either constant or changing over time as prescribed by an user-provided function.

Definition at line 50 of file compute_profile.h.

Member Enumeration Documentation

§ CompositionProfile

An enum describing the different options to compute the reference profile for composition.

Enumerator
initial_composition 
reference_function 

Definition at line 150 of file compute_profile.h.

Constructor & Destructor Documentation

§ ComputeProfile()

Constructor. Initialize variables.

Member Function Documentation

§ initialize()

template<int dim>
virtual void aspect::AdiabaticConditions::ComputeProfile< dim >::initialize ( )
virtual

Initialization function. Because this function is called after initializing the SimulatorAccess, all of the necessary information is available to calculate the adiabatic profile. It computes the adiabatic conditions along a vertical transect of the geometry based on the given material model and other quantities.

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

§ update()

template<int dim>
virtual void aspect::AdiabaticConditions::ComputeProfile< dim >::update ( )
virtual

Update function. By default does nothing, but if a time-dependent surface condition function is used, this will reinitialize the adiabatic profile with the current conditions.

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

§ is_initialized()

template<int dim>
virtual bool aspect::AdiabaticConditions::ComputeProfile< dim >::is_initialized ( ) const
virtual

Some plugins need to know whether the adiabatic conditions are already calculated. This is for example the case for the simple compressible material model, which uses the adiabatic temperature as reference temperature to calculate the density. For the calculation of the adiabatic conditions this functionality is simply switched off, because we are always on the reference profile. This way the plugin behaves differently at initialization time of the adiabatic conditions and during the main model run.

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

§ temperature()

template<int dim>
virtual double aspect::AdiabaticConditions::ComputeProfile< dim >::temperature ( const Point< dim > &  p) const
virtual

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

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

§ pressure()

template<int dim>
virtual double aspect::AdiabaticConditions::ComputeProfile< dim >::pressure ( const Point< dim > &  p) const
virtual

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

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

§ density()

template<int dim>
virtual double aspect::AdiabaticConditions::ComputeProfile< dim >::density ( const Point< dim > &  p) const
virtual

Return the reference density at a given point of the domain.

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

§ density_derivative()

template<int dim>
virtual double aspect::AdiabaticConditions::ComputeProfile< dim >::density_derivative ( const Point< dim > &  p) const
virtual

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

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

§ declare_parameters()

template<int dim>
static void aspect::AdiabaticConditions::ComputeProfile< dim >::declare_parameters ( ParameterHandler prm)
static

§ parse_parameters()

template<int dim>
virtual void aspect::AdiabaticConditions::ComputeProfile< 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 from aspect::AdiabaticConditions::Interface< dim >.

§ get_property()

template<int dim>
double aspect::AdiabaticConditions::ComputeProfile< dim >::get_property ( const Point< dim > &  p,
const std::vector< double > &  property 
) const
private

Internal helper function. Returns the reference property at a given point of the domain.

Member Data Documentation

§ initialized

template<int dim>
bool aspect::AdiabaticConditions::ComputeProfile< dim >::initialized
private

Whether the adiabatic conditions are already calculated. This is important for plugins that are used by the adiabatic conditions but also depend on the adiabatic conditions. This way they can behave differently in initialization and model run.

Definition at line 124 of file compute_profile.h.

§ n_points

template<int dim>
unsigned int aspect::AdiabaticConditions::ComputeProfile< dim >::n_points
private

Number of points at which we compute the adiabatic values.

Definition at line 129 of file compute_profile.h.

§ temperatures

template<int dim>
std::vector<double> aspect::AdiabaticConditions::ComputeProfile< dim >::temperatures
private

Vectors of values of temperatures and pressures on a transect into depth at which we have computed them. The public member functions of this class interpolate linearly between these points.

Definition at line 136 of file compute_profile.h.

§ pressures

template<int dim>
std::vector<double> aspect::AdiabaticConditions::ComputeProfile< dim >::pressures
private

Definition at line 137 of file compute_profile.h.

§ densities

template<int dim>
std::vector<double> aspect::AdiabaticConditions::ComputeProfile< dim >::densities
private

Definition at line 138 of file compute_profile.h.

§ delta_z

template<int dim>
double aspect::AdiabaticConditions::ComputeProfile< dim >::delta_z
private

Interval spacing between each two data points in the tables above with regard to the depth coordinate.

Definition at line 144 of file compute_profile.h.

§ reference_composition

template<int dim>
CompositionProfile aspect::AdiabaticConditions::ComputeProfile< dim >::reference_composition
private

Selected option to compute the reference profile for composition.

Definition at line 159 of file compute_profile.h.

§ composition_function

template<int dim>
std::unique_ptr<Functions::ParsedFunction<1> > aspect::AdiabaticConditions::ComputeProfile< dim >::composition_function
private

Function object that computes the reference composition profile if the reference_composition variable is set to function.

Definition at line 165 of file compute_profile.h.

§ use_surface_condition_function

template<int dim>
bool aspect::AdiabaticConditions::ComputeProfile< dim >::use_surface_condition_function
private

Whether to use the surface_conditions_function to determine surface conditions, or the adiabatic_surface_temperature and surface_pressure parameters. If this is set to true the reference profile is updated every timestep.

Definition at line 173 of file compute_profile.h.

§ surface_condition_function

template<int dim>
Functions::ParsedFunction<1> aspect::AdiabaticConditions::ComputeProfile< dim >::surface_condition_function
private

ParsedFunction: If provided in the inpute file it prescribes (surface pressure(t), surface temperature(t)).

Definition at line 179 of file compute_profile.h.


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