Inheritance diagram for aspect::StokesMatrixFreeHandler< dim >:

[legend]

Public Member Functions
virtual void	setup_dofs ()=0

virtual void	assemble ()=0

virtual void	build_preconditioner ()=0

virtual const DoFHandler< dim > &	get_dof_handler_v () const =0

virtual const DoFHandler< dim > &	get_dof_handler_p () const =0

virtual const DoFHandler< dim > &	get_dof_handler_projection () const =0

virtual const AffineConstraints< double > &	get_constraints_v () const =0

virtual const AffineConstraints< double > &	get_constraints_p () const =0

virtual const MGTransferMF< dim, GMGNumberType > &	get_mg_transfer_A () const =0

virtual const MGTransferMF< dim, GMGNumberType > &	get_mg_transfer_S () const =0

virtual std::size_t	get_cell_data_memory_consumption () const =0

Public Member Functions inherited from aspect::Solver::Interface< dim >
virtual std::pair< double, double >	solve (const LinearAlgebra::BlockSparseMatrix &system_matrix, const LinearAlgebra::BlockVector &system_rhs, LinearAlgebra::BlockVector &solution_vector)=0

virtual std::string	name () const =0

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

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

virtual void	initialize ()

virtual void	update ()

virtual void	parse_parameters (ParameterHandler &prm)

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)

Static Public Member Functions inherited from aspect::Plugins::InterfaceBase
static void	declare_parameters (ParameterHandler &prm)

Detailed Description

template<int dim>
class aspect::StokesMatrixFreeHandler< dim >

Base class for the matrix free GMG solver for the Stokes system. The actual implementation is found inside StokesMatrixFreeHandlerImplementation below.

Definition at line 85 of file simulator.h.

Member Function Documentation

§ setup_dofs()

template<int dim>

virtual void aspect::StokesMatrixFreeHandler< dim >::setup_dofs ( )

pure virtual

Allocates and sets up the members of the StokesMatrixFreeHandler. This is called by Simulator<dim>::setup_dofs()

Implemented in aspect::StokesMatrixFreeHandlerImplementation< dim, velocity_degree >.

§ assemble()

template<int dim>

virtual void aspect::StokesMatrixFreeHandler< dim >::assemble ( )

pure virtual

Perform various tasks to update the linear system to solve for. Note that we are not assembling a matrix (as this is a matrix-free algorithm), but we are evaluating the material model and storing the information necessary for a later call to solve().

Implemented in aspect::StokesMatrixFreeHandlerImplementation< dim, velocity_degree >.

§ build_preconditioner()

template<int dim>

virtual void aspect::StokesMatrixFreeHandler< dim >::build_preconditioner ( )

pure virtual

Computes and sets the diagonal for both the mass matrix operator and the A-block operators on each level for the purpose of smoothing inside the multigrid v-cycle.

Implemented in aspect::StokesMatrixFreeHandlerImplementation< dim, velocity_degree >.

§ declare_parameters()

template<int dim>

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

static

Declare parameters necessary for this solver.

§ get_dof_handler_v()

template<int dim>

virtual const DoFHandler<dim>& aspect::StokesMatrixFreeHandler< dim >::get_dof_handler_v ( ) const

pure virtual

Return a reference to the DoFHandler that is used for velocity in the block GMG solver.

Implemented in aspect::StokesMatrixFreeHandlerImplementation< dim, velocity_degree >.

§ get_dof_handler_p()

template<int dim>

virtual const DoFHandler<dim>& aspect::StokesMatrixFreeHandler< dim >::get_dof_handler_p ( ) const

pure virtual

Return a reference to the DoFHandler that is used for pressure in the block GMG solver.

Implemented in aspect::StokesMatrixFreeHandlerImplementation< dim, velocity_degree >.

§ get_dof_handler_projection()

template<int dim>

virtual const DoFHandler<dim>& aspect::StokesMatrixFreeHandler< dim >::get_dof_handler_projection ( ) const

pure virtual

Return a reference to the DoFHandler that is used for the coefficient projection in the block GMG solver.

Implemented in aspect::StokesMatrixFreeHandlerImplementation< dim, velocity_degree >.

§ get_constraints_v()

template<int dim>

virtual const AffineConstraints<double>& aspect::StokesMatrixFreeHandler< dim >::get_constraints_v ( ) const

pure virtual

Return a pointer to the object that describes the velocity DoF constraints for the block GMG Stokes solver.

Implemented in aspect::StokesMatrixFreeHandlerImplementation< dim, velocity_degree >.

§ get_constraints_p()

template<int dim>

virtual const AffineConstraints<double>& aspect::StokesMatrixFreeHandler< dim >::get_constraints_p ( ) const

pure virtual

Return a pointer to the object that describes the pressure DoF constraints for the block GMG Stokes solver.

Implemented in aspect::StokesMatrixFreeHandlerImplementation< dim, velocity_degree >.

§ get_mg_transfer_A()

template<int dim>

virtual const MGTransferMF<dim,GMGNumberType>& aspect::StokesMatrixFreeHandler< dim >::get_mg_transfer_A ( ) const

pure virtual

Return a pointer to the MGTransfer object used for the A block of the block GMG Stokes solver.

Implemented in aspect::StokesMatrixFreeHandlerImplementation< dim, velocity_degree >.

§ get_mg_transfer_S()

template<int dim>

virtual const MGTransferMF<dim,GMGNumberType>& aspect::StokesMatrixFreeHandler< dim >::get_mg_transfer_S ( ) const

pure virtual

Return a pointer to the MGTransfer object used for the Schur complement block of the block GMG Stokes solver.

Implemented in aspect::StokesMatrixFreeHandlerImplementation< dim, velocity_degree >.

§ get_cell_data_memory_consumption()

template<int dim>

virtual std::size_t aspect::StokesMatrixFreeHandler< dim >::get_cell_data_memory_consumption ( ) const

pure virtual

Return the memory consumption in bytes that are used to store equation data like viscosity to be able to apply the operators.

Implemented in aspect::StokesMatrixFreeHandlerImplementation< dim, velocity_degree >.

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

/home/bob/source/include/aspect/simulator.h
/home/bob/source/include/aspect/stokes_matrix_free.h

Public Member Functions

Static Public Member Functions

Detailed Description

template<int dim> class aspect::StokesMatrixFreeHandler< dim >

Member Function Documentation

§ setup_dofs()

§ assemble()

§ build_preconditioner()

§ declare_parameters()

§ get_dof_handler_v()

§ get_dof_handler_p()

§ get_dof_handler_projection()

§ get_constraints_v()

§ get_constraints_p()

§ get_mg_transfer_A()

§ get_mg_transfer_S()

§ get_cell_data_memory_consumption()

template<int dim>
class aspect::StokesMatrixFreeHandler< dim >