Inheritance diagram for aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >:

Public Member Functions
double	compute_value (const PhaseFunctionInputs< dim > &in) const

double	compute_derivative (const PhaseFunctionInputs< dim > &in) const

unsigned int	n_phase_transitions () const

unsigned int	n_phases () const

unsigned int	n_phases_over_all_chemical_compositions () const

double	get_transition_slope (const unsigned int phase_index) const

double	get_transition_depth (const unsigned int phase_index) const

const std::vector< unsigned int > &	n_phase_transitions_for_each_chemical_composition () const

const std::vector< unsigned int > &	n_phases_for_each_chemical_composition () const

const std::vector< unsigned int > &	n_phase_transitions_for_each_composition () const

const std::vector< unsigned int > &	n_phases_for_each_composition () const

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)

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::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
std::vector< double >	transition_depths

std::vector< double >	transition_pressures

std::vector< double >	transition_temperatures

std::vector< double >	transition_widths

std::vector< double >	transition_pressure_widths

std::vector< double >	transition_slopes

std::vector< double >	transition_temperature_upper_limits

std::vector< double >	transition_temperature_lower_limits

bool	use_depth_instead_of_pressure

std::unique_ptr< std::vector< unsigned int > >	n_phase_transitions_per_composition

std::vector< unsigned int >	n_phases_per_composition

std::vector< unsigned int >	n_phase_transitions_per_chemical_composition

std::vector< unsigned int >	n_phases_per_chemical_composition

unsigned int	n_phases_total

unsigned int	n_phases_total_chemical_compositions

Detailed Description

template<int dim>
class aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >

A class that bundles functionality to compute the values and derivatives of phase functions. The class can handle arbitrary numbers of phase transitions, but the calling side has to determine how to use the return values of this object (e.g. in terms of density or viscosity).

Definition at line 560 of file utilities.h.

Member Function Documentation

§ compute_value()

template<int dim>

double aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::compute_value ( const PhaseFunctionInputs< dim > & in ) const

Percentage of material that has already undergone the phase transition to the higher-pressure material (this is done individually for each transition and summed up in the end)

§ compute_derivative()

template<int dim>

double aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::compute_derivative ( const PhaseFunctionInputs< dim > & in ) const

Return the derivative of the phase function with respect to pressure.

§ n_phase_transitions()

template<int dim>

unsigned int aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phase_transitions ( ) const

Return the total number of phase transitions.

§ n_phases()

template<int dim>

unsigned int aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phases ( ) const

Return the total number of phases.

§ n_phases_over_all_chemical_compositions()

template<int dim>

unsigned int aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phases_over_all_chemical_compositions ( ) const

Return the total number of phases over all chemical compositions.

§ get_transition_slope()

template<int dim>

double aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::get_transition_slope ( const unsigned int phase_index ) const

Return the Clapeyron slope (dp/dT of the transition) for phase transition number phase_index.

§ get_transition_depth()

template<int dim>

double aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::get_transition_depth ( const unsigned int phase_index ) const

Return the depth for phase transition number phase_index.

§ n_phase_transitions_for_each_chemical_composition()

template<int dim>

const std::vector<unsigned int>& aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phase_transitions_for_each_chemical_composition ( ) const

Return how many phase transitions there are for each chemical composition.

§ n_phases_for_each_chemical_composition()

template<int dim>

const std::vector<unsigned int>& aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phases_for_each_chemical_composition ( ) const

Return how many phases there are for each chemical composition.

§ n_phase_transitions_for_each_composition()

template<int dim>

const std::vector<unsigned int>& aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phase_transitions_for_each_composition ( ) const

Return how many phase transitions there are for each composition. Note, that most likely you only need the number of phase transitions for each chemical composition, so use the function above instead. This function is only kept for backward compatibility.

§ n_phases_for_each_composition()

template<int dim>

const std::vector<unsigned int>& aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phases_for_each_composition ( ) const

Return how many phases there are for each composition. Note, that most likely you only need the number of phase transitions for each chemical composition, so use the function above instead. This function is only kept for backward compatibility.

§ declare_parameters()

template<int dim>

static void aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::declare_parameters ( ParameterHandler & prm )

static

Declare the parameters this class takes through input files. Note that this class does not declare its own subsection, i.e. the parameters will be declared in the subsection that was active before calling this function.

§ parse_parameters()

template<int dim>

void aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::parse_parameters ( ParameterHandler & prm )

Read the parameters this class declares from the parameter file. Note that this class does not declare its own subsection, i.e. the parameters will be parsed from the subsection that was active before calling this function.

Member Data Documentation

§ transition_depths

template<int dim>

std::vector<double> aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::transition_depths

private

List of depth (or pressure), width, Clapeyron slopes and limits of temperature for the different phase transitions

Definition at line 657 of file utilities.h.

§ transition_pressures

template<int dim>

std::vector<double> aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::transition_pressures

private

Definition at line 658 of file utilities.h.

§ transition_temperatures

template<int dim>

std::vector<double> aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::transition_temperatures

private

Definition at line 659 of file utilities.h.

§ transition_widths

template<int dim>

std::vector<double> aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::transition_widths

private

Definition at line 660 of file utilities.h.

§ transition_pressure_widths

template<int dim>

std::vector<double> aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::transition_pressure_widths

private

Definition at line 661 of file utilities.h.

§ transition_slopes

template<int dim>

std::vector<double> aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::transition_slopes

private

Definition at line 662 of file utilities.h.

§ transition_temperature_upper_limits

template<int dim>

std::vector<double> aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::transition_temperature_upper_limits

private

Definition at line 663 of file utilities.h.

§ transition_temperature_lower_limits

template<int dim>

std::vector<double> aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::transition_temperature_lower_limits

private

Definition at line 664 of file utilities.h.

§ use_depth_instead_of_pressure

template<int dim>

bool aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::use_depth_instead_of_pressure

private

Whether to define the phase transitions based on depth, or pressure. Based on this parameter, either transition_depths and transition_width, or transition_pressures and transition_pressure_widths determine the depth of the phase transition.

Definition at line 672 of file utilities.h.

§ n_phase_transitions_per_composition

template<int dim>

std::unique_ptr<std::vector<unsigned int> > aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phase_transitions_per_composition

private

A vector that stores how many phase transitions there are for each compositional field.

Definition at line 677 of file utilities.h.

§ n_phases_per_composition

template<int dim>

std::vector<unsigned int> aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phases_per_composition

private

A vector that stores how many phases there are for each compositional field.

Definition at line 682 of file utilities.h.

§ n_phase_transitions_per_chemical_composition

template<int dim>

std::vector<unsigned int> aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phase_transitions_per_chemical_composition

private

A vector that stores how many phase transitions there are for each chemical compositional field.

Definition at line 687 of file utilities.h.

§ n_phases_per_chemical_composition

template<int dim>

std::vector<unsigned int> aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phases_per_chemical_composition

private

A vector that stores how many phases there are for each chemical compositional field.

Definition at line 692 of file utilities.h.

§ n_phases_total

template<int dim>

unsigned int aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phases_total

private

Total number of phases over all compositional fields

Definition at line 697 of file utilities.h.

§ n_phases_total_chemical_compositions

template<int dim>

unsigned int aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >::n_phases_total_chemical_compositions

private

Total number of phases over all compositional fields

Definition at line 702 of file utilities.h.

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

/home/bob/source/include/aspect/material_model/utilities.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

template<int dim> class aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >

Member Function Documentation

§ compute_value()

§ compute_derivative()

§ n_phase_transitions()

§ n_phases()

§ n_phases_over_all_chemical_compositions()

§ get_transition_slope()

§ get_transition_depth()

§ n_phase_transitions_for_each_chemical_composition()

§ n_phases_for_each_chemical_composition()

§ n_phase_transitions_for_each_composition()

§ n_phases_for_each_composition()

§ declare_parameters()

§ parse_parameters()

Member Data Documentation

§ transition_depths

§ transition_pressures

§ transition_temperatures

§ transition_widths

§ transition_pressure_widths

§ transition_slopes

§ transition_temperature_upper_limits

§ transition_temperature_lower_limits

§ use_depth_instead_of_pressure

§ n_phase_transitions_per_composition

§ n_phases_per_composition

§ n_phase_transitions_per_chemical_composition

§ n_phases_per_chemical_composition

§ n_phases_total

§ n_phases_total_chemical_compositions

template<int dim>
class aspect::MaterialModel::MaterialUtilities::PhaseFunction< dim >