Inheritance diagram for aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >:

Public Member Functions
	GrainBoundarySliding ()

void	parse_parameters (ParameterHandler &prm, const std::unique_ptr< std::vector< unsigned int >> &expected_n_phases_per_composition=nullptr)

const GrainBoundarySlidingParameters	compute_slide_parameters (const unsigned int composition, const std::vector< double > &phase_function_values=std::vector< double >(), const std::vector< unsigned int > &n_phase_transitions_per_composition=std::vector< unsigned int >()) const

double	compute_viscosity (const double strain_rate, const double pressure, const double temperature, const unsigned int composition, const std::vector< double > &phase_function_values=std::vector< double >(), const std::vector< unsigned int > &n_phase_transitions_per_composition=std::vector< unsigned int >()) const

double	compute_viscosity (const double strain_rate, const double pressure, const double temperature, const double grain_size, const unsigned int composition, const std::vector< double > &phase_function_values=std::vector< double >(), const std::vector< unsigned int > &n_phase_transitions_per_composition=std::vector< unsigned int >()) 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)

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

std::vector< double >	stress_exponents

std::vector< double >	grain_size_exponents

std::vector< double >	activation_energies

std::vector< double >	activation_volumes

double	fixed_grain_size

Detailed Description

template<int dim>
class aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >

Definition at line 57 of file grain_boundary_sliding.h.

Constructor & Destructor Documentation

◆ GrainBoundarySliding()

template<int dim>

aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >::GrainBoundarySliding ( )

Constructor.

Member Function Documentation

◆ declare_parameters()

template<int dim>

static void aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >::declare_parameters ( ParameterHandler & prm )

static

Declare the parameters this function takes through input files.

◆ parse_parameters()

template<int dim>

void aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >::parse_parameters	(	ParameterHandler &	prm,
		const std::unique_ptr< std::vector< unsigned int >> &	expected_n_phases_per_composition = `nullptr`
	)

Read the parameters this class declares from the parameter file. If expected_n_phases_per_composition points to a vector of unsigned integers this is considered the number of phases for each compositional field and will be checked against the parsed parameters.

◆ compute_slide_parameters()

template<int dim>

const GrainBoundarySlidingParameters aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >::compute_slide_parameters	(	const unsigned int	composition,
		const std::vector< double > &	phase_function_values = `std::vector< double >()`,
		const std::vector< unsigned int > &	n_phase_transitions_per_composition = `std::vector< unsigned int >()`
	)		const

Compute the creep parameters for the grain boundary sliding law. If n_phase_transitions_per_composition points to a vector of unsigned integers this is considered the number of phase transitions for each compositional field and viscosity will be first computed on each phase and then averaged for each compositional field.

◆ compute_viscosity() [1/2]

template<int dim>

double aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >::compute_viscosity	(	const double	strain_rate,
		const double	pressure,
		const double	temperature,
		const unsigned int	composition,
		const std::vector< double > &	phase_function_values = `std::vector< double >()`,
		const std::vector< unsigned int > &	n_phase_transitions_per_composition = `std::vector< unsigned int >()`
	)		const

Compute the viscosity based on the grain boundary sliding law with the fixed grain size given in the input file. If n_phase_transitions_per_composition points to a vector of unsigned integers this is considered the number of phase transitions for each compositional field and viscosity will be first computed on each phase and then averaged for each compositional field.

◆ compute_viscosity() [2/2]

template<int dim>

double aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >::compute_viscosity	(	const double	strain_rate,
		const double	pressure,
		const double	temperature,
		const double	grain_size,
		const unsigned int	composition,
		const std::vector< double > &	phase_function_values = `std::vector< double >()`,
		const std::vector< unsigned int > &	n_phase_transitions_per_composition = `std::vector< unsigned int >()`
	)		const

Compute the viscosity based on the grain boundary sliding law for the given grain_size. If n_phase_transitions_per_composition points to a vector of unsigned integers this is considered the number of phase transitions for each compositional field and viscosity will be first computed on each phase and then averaged for each compositional field.

Member Data Documentation

◆ prefactors

template<int dim>

std::vector<double> aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >::prefactors

private

List of grain boundary sliding prefactors A.

This variable is read from the parameter file through a parameter called 'Prefactors for grain boundary sliding'.

Definition at line 135 of file grain_boundary_sliding.h.

◆ stress_exponents

template<int dim>

std::vector<double> aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >::stress_exponents

private

List of grain boundary sliding stress exponents n (for ice = 1.8). This variable is read from the parameter file through a parameter called 'Stress exponents for grain boundary sliding'.

Definition at line 141 of file grain_boundary_sliding.h.

◆ grain_size_exponents

template<int dim>

std::vector<double> aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >::grain_size_exponents

private

List of grain boundary sliding grain size exponents m. This variable is read from the parameter file through a parameter called 'Grain size exponents for grain boundary sliding'.

Definition at line 147 of file grain_boundary_sliding.h.

◆ activation_energies

template<int dim>

std::vector<double> aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >::activation_energies

private

List of grain boundary sliding activation energies E. This variable is read from the parameter file through a parameter called 'Activation energies for grain boundary sliding'.

Definition at line 153 of file grain_boundary_sliding.h.

◆ activation_volumes

template<int dim>

std::vector<double> aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >::activation_volumes

private

List of grain boundary sliding activation volumes V. This variable is read from the parameter file through a parameter called 'Activation volumes for grain boundary sliding'.

Definition at line 159 of file grain_boundary_sliding.h.

◆ fixed_grain_size

template<int dim>

double aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >::fixed_grain_size

private

Grain boundary sliding grain size d. This is read from the input file, and is only used by the functions that do not take the grain size as additional argument.

This variable is read from the parameter file through a parameter called 'Grain size'.

Definition at line 168 of file grain_boundary_sliding.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/material_model/rheology/grain_boundary_sliding.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

template<int dim> class aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >

Constructor & Destructor Documentation

◆ GrainBoundarySliding()

Member Function Documentation

◆ declare_parameters()

◆ parse_parameters()

◆ compute_slide_parameters()

◆ compute_viscosity() [1/2]

◆ compute_viscosity() [2/2]

Member Data Documentation

◆ prefactors

◆ stress_exponents

◆ grain_size_exponents

◆ activation_energies

◆ activation_volumes

◆ fixed_grain_size

template<int dim>
class aspect::MaterialModel::Rheology::GrainBoundarySliding< dim >