Inheritance diagram for aspect::MaterialModel::DepthDependent< dim >:

Public Member Functions
void	initialize () override

void	update () override

bool	is_compressible () const override

void	evaluate (const typename Interface< dim >::MaterialModelInputs &in, typename Interface< dim >::MaterialModelOutputs &out) const override

void	parse_parameters (ParameterHandler &prm) override

void	create_additional_named_outputs (MaterialModel::MaterialModelOutputs< dim > &out) const override

Public Member Functions inherited from aspect::MaterialModel::Interface< dim >
virtual void	evaluate (const MaterialModel::MaterialModelInputs< dim > &in, MaterialModel::MaterialModelOutputs< dim > &out) const =0

virtual void	fill_additional_material_model_inputs (MaterialModel::MaterialModelInputs< dim > &input, const LinearAlgebra::BlockVector &solution, const FEValuesBase< dim > &fe_values, const Introspection< dim > &introspection) const

const NonlinearDependence::ModelDependence &	get_model_dependence () const

Public Member Functions inherited from aspect::Plugins::InterfaceBase
virtual	~InterfaceBase ()=default

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::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 Types
enum	ViscositySource { function, file, list, none }

Private Member Functions
double	calculate_depth_dependent_prefactor (const double &depth) const

Private Attributes
double	reference_viscosity

ViscositySource	viscosity_source

std::unique_ptr< Functions::InterpolatedTensorProductGridData< 1 > >	viscosity_file_function

std::vector< double >	depth_values

std::vector< double >	viscosity_values

Functions::ParsedFunction< 1 >	viscosity_function

std::unique_ptr< MaterialModel::Interface< dim > >	base_model

std::unique_ptr< Rheology::AsciiDepthProfile< dim > >	depth_dependent_rheology

Additional Inherited Members
Public Types inherited from aspect::MaterialModel::Interface< dim >
using	MaterialModelInputs = MaterialModel::MaterialModelInputs< dim >

using	MaterialModelOutputs = MaterialModel::MaterialModelOutputs< dim >

Protected Attributes inherited from aspect::MaterialModel::Interface< dim >
NonlinearDependence::ModelDependence	model_dependence

Detailed Description

template<int dim>
class aspect::MaterialModel::DepthDependent< dim >

A material model that applies a depth-dependent viscosity to a ''base model'' chosen from any of the other available material models. This depth-dependent material model allows the user to specify a depth-dependent reference viscosity either through a parsed function, lists of depth and viscosity values, or a file. The current implementation only allows for depth-dependence of viscosity - all other properties are derived from the base model.

Definition at line 47 of file depth_dependent.h.

Member Enumeration Documentation

§ ViscositySource

template<int dim>

enum aspect::MaterialModel::DepthDependent::ViscositySource

private

An enum to describe where the depth dependency of the viscosity is coming from.

Enumerator
function
file
list
none

Definition at line 93 of file depth_dependent.h.

Member Function Documentation

§ initialize()

template<int dim>

void aspect::MaterialModel::DepthDependent< dim >::initialize ( )

overridevirtual

Initialize the base model at the beginning of the run.

Reimplemented from aspect::Plugins::InterfaceBase.

§ update()

template<int dim>

void aspect::MaterialModel::DepthDependent< dim >::update ( )

overridevirtual

Update the base model and viscosity function at the beginning of each timestep.

Reimplemented from aspect::Plugins::InterfaceBase.

§ is_compressible()

template<int dim>

bool aspect::MaterialModel::DepthDependent< dim >::is_compressible ( ) const

overridevirtual

Method that indicates whether material is compressible. Depth dependent model is compressible if and only if base model is compressible.

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

§ evaluate()

template<int dim>

void aspect::MaterialModel::DepthDependent< dim >::evaluate	(	const typename Interface< dim >::MaterialModelInputs &	in,
		typename Interface< dim >::MaterialModelOutputs &	out
	)		const

override

Function to compute the material properties in out given the inputs in in.

§ declare_parameters()

template<int dim>

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

static

Method to declare parameters related to depth-dependent model

§ parse_parameters()

template<int dim>

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

overridevirtual

Method to parse parameters related to depth-dependent model

Reimplemented from aspect::Plugins::InterfaceBase.

§ create_additional_named_outputs()

template<int dim>

void aspect::MaterialModel::DepthDependent< dim >::create_additional_named_outputs ( MaterialModel::MaterialModelOutputs< dim > & outputs ) const

overridevirtual

If this material model can produce additional named outputs that are derived from NamedAdditionalOutputs, create them in here. By default, this does nothing.

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

§ calculate_depth_dependent_prefactor()

template<int dim>

double aspect::MaterialModel::DepthDependent< dim >::calculate_depth_dependent_prefactor ( const double & depth ) const

private

Function to calculate depth-dependent multiplicative prefactor to be applied to base model viscosity.

Member Data Documentation

§ reference_viscosity

template<int dim>

double aspect::MaterialModel::DepthDependent< dim >::reference_viscosity

private

The viscosity that will be used as a reference for computing the depth-dependent prefactor.

Definition at line 105 of file depth_dependent.h.

§ viscosity_source

template<int dim>

ViscositySource aspect::MaterialModel::DepthDependent< dim >::viscosity_source

private

Currently chosen source for the viscosity.

Definition at line 110 of file depth_dependent.h.

§ viscosity_file_function

template<int dim>

std::unique_ptr<Functions::InterpolatedTensorProductGridData<1> > aspect::MaterialModel::DepthDependent< dim >::viscosity_file_function

private

Data structures to store depth and viscosity lookup tables as well as interpolating function to calculate viscosity for File Depth dependence method

Definition at line 116 of file depth_dependent.h.

§ depth_values

template<int dim>

std::vector<double> aspect::MaterialModel::DepthDependent< dim >::depth_values

private

Values of depth specified by the user if using the depth dependence method 'list'

Definition at line 128 of file depth_dependent.h.

§ viscosity_values

template<int dim>

std::vector<double> aspect::MaterialModel::DepthDependent< dim >::viscosity_values

private

Definition at line 129 of file depth_dependent.h.

§ viscosity_function

template<int dim>

Functions::ParsedFunction<1> aspect::MaterialModel::DepthDependent< dim >::viscosity_function

private

Parsed function that specifies viscosity depth-dependence when using the 'function' method.

Definition at line 135 of file depth_dependent.h.

§ base_model

template<int dim>

std::unique_ptr<MaterialModel::Interface<dim> > aspect::MaterialModel::DepthDependent< dim >::base_model

private

Pointer to the material model used as the base model

Definition at line 140 of file depth_dependent.h.

§ depth_dependent_rheology

template<int dim>

std::unique_ptr<Rheology::AsciiDepthProfile<dim> > aspect::MaterialModel::DepthDependent< dim >::depth_dependent_rheology

private

Pointer to the rheology model used for depth-dependence from an ascii file

Definition at line 146 of file depth_dependent.h.

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

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

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<int dim> class aspect::MaterialModel::DepthDependent< dim >

Member Enumeration Documentation

§ ViscositySource

Member Function Documentation

§ initialize()

§ update()

§ is_compressible()

§ evaluate()

§ declare_parameters()

§ parse_parameters()

§ create_additional_named_outputs()

§ calculate_depth_dependent_prefactor()

Member Data Documentation

§ reference_viscosity

§ viscosity_source

§ viscosity_file_function

§ depth_values

§ viscosity_values

§ viscosity_function

§ base_model

§ depth_dependent_rheology

template<int dim>
class aspect::MaterialModel::DepthDependent< dim >