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

Public Member Functions

virtual void initialize ()
 
virtual void update ()
 
virtual void evaluate (const typename Interface< dim >::MaterialModelInputs &in, typename Interface< dim >::MaterialModelOutputs &out) const
 
virtual void parse_parameters (ParameterHandler &prm)
 
virtual bool is_compressible () const
 
virtual double reference_viscosity () const
 
- Public Member Functions inherited from aspect::MaterialModel::Interface< dim >
virtual ~Interface ()
 
virtual void evaluate (const MaterialModel::MaterialModelInputs< dim > &in, MaterialModel::MaterialModelOutputs< dim > &out) const =0
 
virtual void create_additional_named_outputs (MaterialModelOutputs &outputs) const
 
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::ModelDependenceget_model_dependence () 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::MaterialModel::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  ViscositySource { Function, File, List, None }
 

Private Member Functions

void read_viscosity_file (const std::string &filename, const MPI_Comm &comm)
 
double viscosity_from_list (const double &depth) const
 
double viscosity_from_file (const double &depth) const
 
double calculate_depth_dependent_prefactor (const double &depth) const
 

Private Attributes

ViscositySource viscosity_source
 
std::shared_ptr< Functions::InterpolatedTensorProductGridData< 1 > > viscosity_file_function
 
std::vector< double > depth_values
 
std::vector< double > viscosity_values
 
Functions::ParsedFunction< 1 > viscosity_function
 
std::shared_ptr< MaterialModel::Interface< dim > > base_model
 

Additional Inherited Members

- Public Types inherited from aspect::MaterialModel::Interface< dim >
typedef MaterialModel::MaterialModelInputs< dim > MaterialModelInputs
 
typedef MaterialModel::MaterialModelOutputs< dim > MaterialModelOutputs
 
- 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 45 of file depth_dependent.h.

Member Enumeration Documentation

§ ViscositySource

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

Enumerator
Function 
File 
List 
None 

Definition at line 99 of file depth_dependent.h.

Member Function Documentation

§ initialize()

template<int dim>
virtual void aspect::MaterialModel::DepthDependent< dim >::initialize ( )
virtual

Initialize the base model at the beginning of the run.

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

§ update()

template<int dim>
virtual void aspect::MaterialModel::DepthDependent< dim >::update ( )
virtual

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

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

§ evaluate()

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

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>
virtual void aspect::MaterialModel::DepthDependent< dim >::parse_parameters ( ParameterHandler prm)
virtual

Method to parse parameters related to depth-dependent model

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

§ is_compressible()

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

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

§ reference_viscosity()

template<int dim>
virtual double aspect::MaterialModel::DepthDependent< dim >::reference_viscosity ( ) const
virtual

Method to calculate reference viscosity for the depth-dependent model. The reference viscosity is determined by evaluating the depth-dependent part of the viscosity at the mean depth of the model.

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

§ read_viscosity_file()

template<int dim>
void aspect::MaterialModel::DepthDependent< dim >::read_viscosity_file ( const std::string &  filename,
const MPI_Comm &  comm 
)
private

Function to read depth-dependent lookup table and set up interpolating function for File depth dependence method

§ viscosity_from_list()

template<int dim>
double aspect::MaterialModel::DepthDependent< dim >::viscosity_from_list ( const double &  depth) const
private

Function to calculate viscosity at depth using values provided as List input

§ viscosity_from_file()

template<int dim>
double aspect::MaterialModel::DepthDependent< dim >::viscosity_from_file ( const double &  depth) const
private

function to calculate viscosity at depth using values provided from File input

§ 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

§ 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::shared_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 124 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 List depth dependence method

Definition at line 148 of file depth_dependent.h.

§ viscosity_values

template<int dim>
std::vector<double> aspect::MaterialModel::DepthDependent< dim >::viscosity_values
private

Definition at line 149 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 154 of file depth_dependent.h.

§ base_model

template<int dim>
std::shared_ptr<MaterialModel::Interface<dim> > aspect::MaterialModel::DepthDependent< dim >::base_model
private

Pointer to the material model used as the base model

Definition at line 159 of file depth_dependent.h.


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