 |
ASPECT
|
|
ASPECT
|
Classes | |
| struct | AdvectionFieldMethod |
| struct | Formulation |
| struct | NonlinearSolver |
| struct | NullspaceRemoval |
| The NullspaceRemoval struct. More... | |
Public Member Functions | |
| Parameters (ParameterHandler &prm, MPI_Comm mpi_communicator) | |
| void | parse_parameters (ParameterHandler &prm, const MPI_Comm mpi_communicator) |
| void | parse_geometry_dependent_parameters (ParameterHandler &prm, const GeometryModel::Interface< dim > &geometry_model) |
Static Public Member Functions | |
| static void | declare_parameters (ParameterHandler &prm) |
A structure that holds run-time parameters. These parameters are all declared for the ParameterHandler class in the declare_parameters() member function, and read in the parse_parameters() function.
Each of the member variables of this class corresponds to a parameter declared for the ParameterHandler class. Rather than duplicating the documentation of each of these parameters for the member variables here, please refer to the documentation of run-time parameters in the ASPECT manual for more information.
Definition at line 56 of file parameters.h.
| aspect::Parameters< dim >::Parameters | ( | ParameterHandler & | prm, |
| MPI_Comm | mpi_communicator | ||
| ) |
Constructor. Fills the values of member functions from the given parameter object.
| prm | The parameter object that has previously been filled with content by reading an input file. |
| mpi_communicator | The MPI communicator we will use for this simulation. We need this when calling parse_parameters() so that we can verify some of the input arguments. |
|
static |
Declare the run-time parameters this class takes, and call the respective declare_parameters functions of the namespaces that describe geometries, material models, etc.
| prm | The object in which the run-time parameters are to be declared. |
| void aspect::Parameters< dim >::parse_parameters | ( | ParameterHandler & | prm, |
| const MPI_Comm | mpi_communicator | ||
| ) |
Read run-time parameters from an object that has previously parsed an input file. This reads all parameters that do not require knowledge of the geometry model we use. There is a separate function parse_geometry_dependent_parameters() that is called as soon as the geometry object has been created and that can translate between the symbolic names for boundary components that the geometry model publishes and the boundary indicators used internally.
| prm | The object from which to obtain the run-time parameters. |
| mpi_communicator | The MPI communicator we will use for this simulation. We need this when calling parse_parameters() so that we can verify some of the input arguments. |
| void aspect::Parameters< dim >::parse_geometry_dependent_parameters | ( | ParameterHandler & | prm, |
| const GeometryModel::Interface< dim > & | geometry_model | ||
| ) |
Read those run-time parameters from a ParameterHandler object that depend on knowing which geometry object we use. This function complements parse_parameters() but is only called once the geometry object has been created. This function is separate because we allow the use of symbolic names in defining which boundary components have which boundary conditions, and the names one can specify there are not available until after the geometry object has been created.
This function is called from the GeometryModel::create_geometry() function.
| prm | The object from which to obtain the run-time parameters. |
| geometry_model | The geometry model that provides boundary names etc. |
| NonlinearSolver::Kind aspect::Parameters< dim >::nonlinear_solver |
Definition at line 318 of file parameters.h.
| double aspect::Parameters< dim >::nonlinear_tolerance |
Definition at line 320 of file parameters.h.
| bool aspect::Parameters< dim >::resume_computation |
Definition at line 321 of file parameters.h.
| double aspect::Parameters< dim >::start_time |
Definition at line 322 of file parameters.h.
| double aspect::Parameters< dim >::CFL_number |
Definition at line 323 of file parameters.h.
| double aspect::Parameters< dim >::maximum_time_step |
Definition at line 324 of file parameters.h.
| double aspect::Parameters< dim >::maximum_relative_increase_time_step |
Definition at line 325 of file parameters.h.
| double aspect::Parameters< dim >::maximum_first_time_step |
Definition at line 326 of file parameters.h.
| bool aspect::Parameters< dim >::use_artificial_viscosity_smoothing |
Definition at line 327 of file parameters.h.
| bool aspect::Parameters< dim >::use_conduction_timestep |
Definition at line 328 of file parameters.h.
| bool aspect::Parameters< dim >::convert_to_years |
Definition at line 329 of file parameters.h.
| std::string aspect::Parameters< dim >::output_directory |
Definition at line 330 of file parameters.h.
| double aspect::Parameters< dim >::surface_pressure |
Definition at line 331 of file parameters.h.
| double aspect::Parameters< dim >::adiabatic_surface_temperature |
Definition at line 332 of file parameters.h.
| unsigned int aspect::Parameters< dim >::timing_output_frequency |
Definition at line 333 of file parameters.h.
| unsigned int aspect::Parameters< dim >::max_nonlinear_iterations |
Definition at line 334 of file parameters.h.
| unsigned int aspect::Parameters< dim >::max_nonlinear_iterations_in_prerefinement |
Definition at line 335 of file parameters.h.
| bool aspect::Parameters< dim >::use_operator_splitting |
Definition at line 336 of file parameters.h.
| std::string aspect::Parameters< dim >::world_builder_file |
Definition at line 337 of file parameters.h.
| double aspect::Parameters< dim >::temperature_solver_tolerance |
Definition at line 347 of file parameters.h.
| double aspect::Parameters< dim >::composition_solver_tolerance |
Definition at line 348 of file parameters.h.
| bool aspect::Parameters< dim >::use_direct_stokes_solver |
Definition at line 351 of file parameters.h.
| double aspect::Parameters< dim >::linear_stokes_solver_tolerance |
Definition at line 352 of file parameters.h.
| unsigned int aspect::Parameters< dim >::n_cheap_stokes_solver_steps |
Definition at line 353 of file parameters.h.
| unsigned int aspect::Parameters< dim >::n_expensive_stokes_solver_steps |
Definition at line 354 of file parameters.h.
| double aspect::Parameters< dim >::linear_solver_A_block_tolerance |
Definition at line 355 of file parameters.h.
| bool aspect::Parameters< dim >::use_full_A_block_preconditioner |
Definition at line 356 of file parameters.h.
| double aspect::Parameters< dim >::linear_solver_S_block_tolerance |
Definition at line 357 of file parameters.h.
| unsigned int aspect::Parameters< dim >::stokes_gmres_restart_length |
Definition at line 358 of file parameters.h.
| std::string aspect::Parameters< dim >::AMG_smoother_type |
Definition at line 361 of file parameters.h.
| unsigned int aspect::Parameters< dim >::AMG_smoother_sweeps |
Definition at line 362 of file parameters.h.
| double aspect::Parameters< dim >::AMG_aggregation_threshold |
Definition at line 363 of file parameters.h.
| bool aspect::Parameters< dim >::AMG_output_details |
Definition at line 364 of file parameters.h.
| double aspect::Parameters< dim >::reaction_time_step |
Definition at line 367 of file parameters.h.
| unsigned int aspect::Parameters< dim >::reaction_steps_per_advection_step |
Definition at line 368 of file parameters.h.
| double aspect::Parameters< dim >::diffusion_length_scale |
Definition at line 371 of file parameters.h.
| Formulation::Kind aspect::Parameters< dim >::formulation |
This variable determines which of the several ways to formulate the equations ASPECT will solve. Common formulations are the Boussinesq or Anelastic Liquid Approximations (BA, ALA). ASPECT's original formulation is termed 'isothermal compression'. 'Custom' allows to set the approximations individually per equation.
Definition at line 390 of file parameters.h.
| Formulation::MassConservation::Kind aspect::Parameters< dim >::formulation_mass_conservation |
Determines how to formulate the mass conservation equation in ASPECT. Common approximations are 'incompressible' or 'reference density profile'. ASPECT's original formulation is termed 'isothermal compression'. See the manual for more details about the individual terms.
Definition at line 398 of file parameters.h.
| Formulation::TemperatureEquation::Kind aspect::Parameters< dim >::formulation_temperature_equation |
Determines how to formulate the density in the temperature equation in ASPECT. Possible approximations are 'reference density profile' or 'real density'.
Definition at line 405 of file parameters.h.
| bool aspect::Parameters< dim >::enable_elasticity |
This variable determines whether additional terms related to elastic forces are added to the Stokes equation.
Definition at line 411 of file parameters.h.
| bool aspect::Parameters< dim >::include_melt_transport |
Definition at line 421 of file parameters.h.
| bool aspect::Parameters< dim >::enable_additional_stokes_rhs |
Definition at line 422 of file parameters.h.
| std::map<types::boundary_id, std::pair<std::string,std::string> > aspect::Parameters< dim >::prescribed_traction_boundary_indicators |
Map from boundary id to a pair "components", "traction boundary type", where components is of the format "[x][y][z]" and the traction type is mapped to one of the plugins of traction boundary conditions (e.g. "function")
Definition at line 430 of file parameters.h.
| std::set<types::boundary_id> aspect::Parameters< dim >::fixed_heat_flux_boundary_indicators |
A set of boundary ids on which the boundary_heat_flux objects will be applied.
Definition at line 436 of file parameters.h.
| NullspaceRemoval::Kind aspect::Parameters< dim >::nullspace_removal |
Selection of operations to perform to remove nullspace from velocity field.
Definition at line 442 of file parameters.h.
| unsigned int aspect::Parameters< dim >::initial_global_refinement |
Definition at line 451 of file parameters.h.
| unsigned int aspect::Parameters< dim >::initial_adaptive_refinement |
Definition at line 452 of file parameters.h.
| double aspect::Parameters< dim >::refinement_fraction |
Definition at line 453 of file parameters.h.
| double aspect::Parameters< dim >::coarsening_fraction |
Definition at line 454 of file parameters.h.
| bool aspect::Parameters< dim >::adapt_by_fraction_of_cells |
Definition at line 455 of file parameters.h.
| unsigned int aspect::Parameters< dim >::min_grid_level |
Definition at line 456 of file parameters.h.
| std::vector<double> aspect::Parameters< dim >::additional_refinement_times |
Definition at line 457 of file parameters.h.
| unsigned int aspect::Parameters< dim >::adaptive_refinement_interval |
Definition at line 458 of file parameters.h.
| bool aspect::Parameters< dim >::skip_solvers_on_initial_refinement |
Definition at line 459 of file parameters.h.
| bool aspect::Parameters< dim >::skip_setup_initial_conditions_on_initial_refinement |
Definition at line 460 of file parameters.h.
| bool aspect::Parameters< dim >::run_postprocessors_on_initial_refinement |
Definition at line 461 of file parameters.h.
| bool aspect::Parameters< dim >::run_postprocessors_on_nonlinear_iterations |
Definition at line 462 of file parameters.h.
| unsigned int aspect::Parameters< dim >::stabilization_alpha |
Definition at line 472 of file parameters.h.
| std::vector<double> aspect::Parameters< dim >::stabilization_c_R |
Definition at line 473 of file parameters.h.
| std::vector<double> aspect::Parameters< dim >::stabilization_beta |
Definition at line 474 of file parameters.h.
| double aspect::Parameters< dim >::stabilization_gamma |
Definition at line 475 of file parameters.h.
| double aspect::Parameters< dim >::discontinuous_penalty |
Definition at line 476 of file parameters.h.
| bool aspect::Parameters< dim >::use_limiter_for_discontinuous_temperature_solution |
Definition at line 477 of file parameters.h.
| bool aspect::Parameters< dim >::use_limiter_for_discontinuous_composition_solution |
Definition at line 478 of file parameters.h.
| double aspect::Parameters< dim >::global_temperature_max_preset |
Definition at line 479 of file parameters.h.
| double aspect::Parameters< dim >::global_temperature_min_preset |
Definition at line 480 of file parameters.h.
| std::vector<double> aspect::Parameters< dim >::global_composition_max_preset |
Definition at line 481 of file parameters.h.
| std::vector<double> aspect::Parameters< dim >::global_composition_min_preset |
Definition at line 482 of file parameters.h.
| int aspect::Parameters< dim >::checkpoint_time_secs |
Definition at line 491 of file parameters.h.
| int aspect::Parameters< dim >::checkpoint_steps |
Definition at line 492 of file parameters.h.
| unsigned int aspect::Parameters< dim >::stokes_velocity_degree |
Definition at line 501 of file parameters.h.
| bool aspect::Parameters< dim >::use_locally_conservative_discretization |
Definition at line 502 of file parameters.h.
| bool aspect::Parameters< dim >::use_discontinuous_temperature_discretization |
Definition at line 503 of file parameters.h.
| bool aspect::Parameters< dim >::use_discontinuous_composition_discretization |
Definition at line 504 of file parameters.h.
| unsigned int aspect::Parameters< dim >::temperature_degree |
Definition at line 505 of file parameters.h.
| unsigned int aspect::Parameters< dim >::composition_degree |
Definition at line 506 of file parameters.h.
| std::string aspect::Parameters< dim >::pressure_normalization |
Definition at line 507 of file parameters.h.
| MaterialModel::MaterialAveraging::AveragingOperation aspect::Parameters< dim >::material_averaging |
Definition at line 508 of file parameters.h.
| unsigned int aspect::Parameters< dim >::n_compositional_fields |
Definition at line 518 of file parameters.h.
| std::vector<std::string> aspect::Parameters< dim >::names_of_compositional_fields |
Definition at line 519 of file parameters.h.
| std::vector<typename AdvectionFieldMethod::Kind> aspect::Parameters< dim >::compositional_field_methods |
A vector that contains the advection field method for every compositional field. Consequently the vector has n_compositional_fields entries.
Definition at line 525 of file parameters.h.
| std::map<unsigned int, std::pair<std::string,unsigned int> > aspect::Parameters< dim >::mapped_particle_properties |
Map from compositional index to a pair "particle property", "component", where particle property is a string that can be mapped to one of the particle property plugins. Component denotes which component of the particle property is to be mapped in case there are several. Therefore, it is optional to specify the component and it is of the format "[0][1][2]". In case no component is specified it defaults to 0.
Definition at line 536 of file parameters.h.
| std::vector<unsigned int> aspect::Parameters< dim >::normalized_fields |
Definition at line 538 of file parameters.h.
| bool aspect::Parameters< dim >::free_surface_enabled |
Definition at line 546 of file parameters.h.
| std::set<types::boundary_id> aspect::Parameters< dim >::free_surface_boundary_indicators |
Definition at line 547 of file parameters.h.
| bool aspect::Parameters< dim >::volume_of_fluid_tracking_enabled |
Definition at line 556 of file parameters.h.