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

Public Member Functions
void	evaluate (const MaterialModel::MaterialModelInputs< dim > &in, MaterialModel::MaterialModelOutputs< dim > &out) const override

Qualitative properties one can ask a material model
bool	is_compressible () const override

Public Member Functions inherited from aspect::MaterialModel::Interface< dim >
virtual	~Interface ()=default

virtual void	initialize ()

virtual void	update ()

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::ModelDependence &	get_model_dependence () const

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

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::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 std::map< types::boundary_id, std::unique_ptr< BoundaryTraction::Interface< dim > > > &	get_boundary_traction () 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

const Particle::World< dim > &	get_particle_world () const

Particle::World< dim > &	get_particle_world ()

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

Private Attributes
double	reference_T

MaterialUtilities::CompositionalAveragingOperation	viscosity_averaging

std::vector< double >	viscosities

std::vector< double >	thermal_conductivities

EquationOfState::MulticomponentIncompressible< dim >	equation_of_state

Functions used in dealing with run-time parameters
void	parse_parameters (ParameterHandler &prm) override

static void	declare_parameters (ParameterHandler &prm)

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

using	MaterialModelOutputs = MaterialModel::MaterialModelOutputs< dim >

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)

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

Detailed Description

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

An incompressible material model which is intended for use with multiple compositional fields. Each compositional field is meant to be a single rock type, where the value of the field at a point is interpreted to be a volume fraction of that rock type. If the sum of the compositional field volume fractions is less than one, then the remainder of the volume is assumed to be ``background mantle''. If the sum of the compositional field volume fractions is greater than one, then they are renormalized to sum to one and there is no background mantle.

For each material parameter the user supplies a comma delimited list of length N+1, where N is the number of compositional fields. The additional field corresponds to the value for background mantle. They should be ordered ``background, composition1, composition2...''

If a single value is given, then all the compositional fields are given that value. Other lengths of lists are not allowed. For a given compositional field the material parameters are treated as constant, except density, which varies linearly with temperature according to the thermal expansivity.

When more than one field is present at a point, they are averaged arithmetically. An exception is viscosity, which may be averaged arithmetically, harmonically, geometrically, or by selecting the viscosity of the composition with the greatest volume fraction.

Definition at line 64 of file multicomponent.h.

Member Function Documentation

§ evaluate()

template<int dim>

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

overridevirtual

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

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

§ is_compressible()

template<int dim>

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

overridevirtual

This model is not compressible, so this returns false.

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

§ declare_parameters()

template<int dim>

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

static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>

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

overridevirtual

Read the parameters this class declares from the parameter file.

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

Member Data Documentation

§ reference_T

template<int dim>

double aspect::MaterialModel::Multicomponent< dim >::reference_T

private

Reference temperature for thermal expansion. All components use the same reference_T.

Definition at line 116 of file multicomponent.h.

§ viscosity_averaging

template<int dim>

MaterialUtilities::CompositionalAveragingOperation aspect::MaterialModel::Multicomponent< dim >::viscosity_averaging

private

Enumeration for selecting which viscosity averaging scheme to use.

Definition at line 121 of file multicomponent.h.

§ viscosities

template<int dim>

std::vector<double> aspect::MaterialModel::Multicomponent< dim >::viscosities

private

Vector for field viscosities, read from parameter file.

Definition at line 126 of file multicomponent.h.

§ thermal_conductivities

template<int dim>

std::vector<double> aspect::MaterialModel::Multicomponent< dim >::thermal_conductivities

private

Vector for field thermal conductivities, read from parameter file.

Definition at line 131 of file multicomponent.h.

§ equation_of_state

template<int dim>

EquationOfState::MulticomponentIncompressible<dim> aspect::MaterialModel::Multicomponent< dim >::equation_of_state

private

Definition at line 133 of file multicomponent.h.

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

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

Public Member Functions

Private Attributes

Functions used in dealing with run-time parameters

Additional Inherited Members

Detailed Description

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

Member Function Documentation

§ evaluate()

§ is_compressible()

§ declare_parameters()

§ parse_parameters()

Member Data Documentation

§ reference_T

§ viscosity_averaging

§ viscosities

§ thermal_conductivities

§ equation_of_state

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