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

Public Member Functions

std::vector< std::vector< double > > properties_at_points (const ParticleHandler< dim > &particle_handler, const std::vector< Point< dim >> &positions, const ComponentMask &selected_properties, const typename parallel::distributed::Triangulation< dim >::active_cell_iterator &cell) const override
 
void parse_parameters (ParameterHandler &prm) override
 
- Public Member Functions inherited from aspect::Particle::ParticleInterfaceBase
 ParticleInterfaceBase ()
 
void set_particle_manager_index (unsigned int particle_manager_index)
 Set which particle manager the plugin belongs to. More...
 
unsigned int get_particle_manager_index () const
 Gets which particle manager the plugin belong to. More...
 
- Public Member Functions inherited from aspect::Plugins::InterfaceBase
virtual ~InterfaceBase ()=default
 
virtual void initialize ()
 
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::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
 
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
 

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

double evaluate_interpolation_function (const Vector< double > &coefficients, const Point< dim > &position) const
 
std::pair< double, double > get_interpolation_bounds (const ::Vector< double > &coefficients) const
 
std::vector<::Point< dim > > get_critical_points (const ::Vector< double > &coefficients) const
 

Private Attributes

Interpolator::CellAverage< dim > fallback_interpolator
 
ComponentMask use_quadratic_least_squares_limiter
 
ComponentMask use_boundary_extrapolation
 

Detailed Description

template<int dim>
class aspect::Particle::Interpolator::QuadraticLeastSquares< dim >

Return the properties of all particles of the given cell by using a least squares projection onto the space of quadratic functions. For more details on the implementation and properties of this plugin see: Mack Gregory and Elbridge Gerry Puckett (2020), "Improving the Accuracy and Efficiency of Hybrid Finite Element / Particle-In-Cell Methods for Modeling Geologic Processes", Abstract Submission ID# 743654 https://agu.confex.com/agu/fm20/prelim.cgi/Paper/743654 Session: A002 - Addressing Challenges for the Next Generation of Earth System Models Submitted to 2020 AGU Fall Meeting, San Francisco, CA Dec. 7-11, 2020

Definition at line 49 of file quadratic_least_squares.h.

Member Function Documentation

§ properties_at_points()

template<int dim>
std::vector<std::vector<double> > aspect::Particle::Interpolator::QuadraticLeastSquares< dim >::properties_at_points ( const ParticleHandler< dim > &  particle_handler,
const std::vector< Point< dim >> &  positions,
const ComponentMask &  selected_properties,
const typename parallel::distributed::Triangulation< dim >::active_cell_iterator &  cell 
) const
overridevirtual

Return the cell-wise evaluated properties of the quadratic least squares function at the positions.

Implements aspect::Particle::Interpolator::Interface< dim >.

§ declare_parameters()

template<int dim>
static void aspect::Particle::Interpolator::QuadraticLeastSquares< dim >::declare_parameters ( ParameterHandler &  prm)
static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>
void aspect::Particle::Interpolator::QuadraticLeastSquares< dim >::parse_parameters ( ParameterHandler &  prm)
overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

§ evaluate_interpolation_function()

template<int dim>
double aspect::Particle::Interpolator::QuadraticLeastSquares< dim >::evaluate_interpolation_function ( const Vector< double > &  coefficients,
const Point< dim > &  position 
) const
private

Calculate the value of the interpolation function at a given position

§ get_interpolation_bounds()

template<int dim>
std::pair<double, double> aspect::Particle::Interpolator::QuadraticLeastSquares< dim >::get_interpolation_bounds ( const ::Vector< double > &  coefficients) const
private

Update the bounds of where the plane reaches by checking whether each of the critical points are in the cell and evauating their value.

§ get_critical_points()

template<int dim>
std::vector<::Point<dim> > aspect::Particle::Interpolator::QuadraticLeastSquares< dim >::get_critical_points ( const ::Vector< double > &  coefficients) const
private

Member Data Documentation

§ fallback_interpolator

template<int dim>
Interpolator::CellAverage<dim> aspect::Particle::Interpolator::QuadraticLeastSquares< dim >::fallback_interpolator
private

Use the cell average interpolator in case the quadratic least squares interpolator fails due to a lack of particles.

Definition at line 82 of file quadratic_least_squares.h.

§ use_quadratic_least_squares_limiter

template<int dim>
ComponentMask aspect::Particle::Interpolator::QuadraticLeastSquares< dim >::use_quadratic_least_squares_limiter
private

Enables a limiting scheme that prevents overshoot and undershoot of interpolated particles based upon the range of property values found in the area of the cell.

Definition at line 89 of file quadratic_least_squares.h.

§ use_boundary_extrapolation

template<int dim>
ComponentMask aspect::Particle::Interpolator::QuadraticLeastSquares< dim >::use_boundary_extrapolation
private

Enables a linear extrapolation of boundary values for the limiting scheme

Definition at line 94 of file quadratic_least_squares.h.


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