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

Public Member Functions
void	initialize () override

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

void	create_additional_named_outputs (typename Interface< dim >::MaterialModelOutputs &outputs) const override

void	parse_parameters (ParameterHandler &prm) override

bool	is_compressible () 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	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::Plugins::InterfaceBase
virtual	~InterfaceBase ()=default

virtual void	update ()

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_worlds () const

const Particle::World< dim > &	get_particle_world (const unsigned int particle_world_index) const

Particle::World< dim > &	get_particle_world (const unsigned int particle_world_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 Member Functions
void	copy_required_properties (const unsigned int model_index, const typename Interface< dim >::MaterialModelOutputs &base_output, typename Interface< dim >::MaterialModelOutputs &out) const

Private Attributes
std::map< Property::MaterialProperty, unsigned int >	model_property_map

std::vector< std::string >	model_names

std::vector< std::unique_ptr< Interface< dim > > >	models

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::Compositing< dim >

A material model that selects properties from other (non-compositing) material models.

Definition at line 62 of file compositing.h.

Member Function Documentation

§ initialize()

template<int dim>

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

overridevirtual

Initialization function. This function is called once at the beginning of the program after parse_parameters() is run and after the SimulatorAccess (if applicable) is initialized.

The default implementation of this function does nothing, but plugins that derive from this class (via the Interface classes of their respective plugin systems) may overload it if they want something to happen upon startup of the Simulator object to which the plugin contributes.

Reimplemented from aspect::Plugins::InterfaceBase.

§ evaluate()

template<int dim>

void aspect::MaterialModel::Compositing< 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.

§ create_additional_named_outputs()

template<int dim>

void aspect::MaterialModel::Compositing< dim >::create_additional_named_outputs ( typename Interface< dim >::MaterialModelOutputs & outputs ) const

override

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

§ declare_parameters()

template<int dim>

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

static

Declare the parameters the plugin takes through input files. The default implementation of this function does not describe any parameters. Consequently, derived classes do not have to overload this function if they do not take any runtime parameters. On the other hand, most plugins do have run-time parameters, and they may then overload this function.

§ parse_parameters()

template<int dim>

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

overridevirtual

Read the parameters this class declares from the parameter file. The default implementation of this function does not read any parameters. Consequently, derived classes do not have to overload this function if they do not take any runtime parameters. On the other hand, most plugins do have run-time parameters, and they may then overload this function.

Reimplemented from aspect::Plugins::InterfaceBase.

§ is_compressible()

template<int dim>

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

overridevirtual

Return whether the model is compressible or not. Incompressibility does not necessarily imply that the density is constant; rather, it may still depend on temperature or pressure. In the current context, compressibility means whether we should solve the continuity equation as \(\nabla \cdot (\rho \mathbf u)=0\) (compressible Stokes) or as \(\nabla \cdot \mathbf{u}=0\) (incompressible Stokes).

Returns value from material model providing compressibility.

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

§ copy_required_properties()

template<int dim>

void aspect::MaterialModel::Compositing< dim >::copy_required_properties	(	const unsigned int	model_index,
		const typename Interface< dim >::MaterialModelOutputs &	base_output,
		typename Interface< dim >::MaterialModelOutputs &	out
	)		const

private

Copy desired properties from material model outputs produced by another material model,

Parameters

model_index	Internal index for pointer to the material model evaluated
base_output	Properties generated by the material model specified
out	MaterialModelOutputs to be used.

Member Data Documentation

§ model_property_map

template<int dim>

std::map<Property::MaterialProperty, unsigned int> aspect::MaterialModel::Compositing< dim >::model_property_map

private

Map specifying which material model is responsible for a property.

Definition at line 124 of file compositing.h.

§ model_names

template<int dim>

std::vector<std::string> aspect::MaterialModel::Compositing< dim >::model_names

private

Names of and pointers to the material models used for compositing.

Definition at line 130 of file compositing.h.

§ models

template<int dim>

std::vector<std::unique_ptr<Interface<dim> > > aspect::MaterialModel::Compositing< dim >::models

private

Definition at line 131 of file compositing.h.

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

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Function Documentation

§ initialize()

§ evaluate()

§ create_additional_named_outputs()

§ declare_parameters()

§ parse_parameters()

§ is_compressible()

§ copy_required_properties()

Member Data Documentation

§ model_property_map

§ model_names

§ models

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