ASPECT
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
aspect::Particle::Generator::UniformRadial< dim > Class Template Reference
Describing advected particles » Describing the method to generate particles
Inheritance diagram for aspect::Particle::Generator::UniformRadial< dim >:
Inheritance graph
[legend]

Public Member Functions

void generate_particles (Particles::ParticleHandler< dim > &particle_handler) override
 
void parse_parameters (ParameterHandler &prm) override
 
- Public Member Functions inherited from aspect::Particle::Generator::Interface< dim >
 Interface ()
 
 ~Interface () override=default
 
virtual void initialize ()
 
virtual DEAL_II_DEPRECATED void generate_particles (std::multimap< Particles::internal::LevelInd, Particle< dim >> &particles)
 
std::pair< Particles::internal::LevelInd, Particle< dim > > generate_particle (const typename parallel::distributed::Triangulation< dim >::active_cell_iterator &cell, const types::particle_index id)
 
- 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
 
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
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 
- Static Public Member Functions inherited from aspect::Particle::Generator::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)
 

Private Attributes

std::array< double, dim > P_min
 
std::array< double, dim > P_max
 
Point< dim > P_center
 
unsigned int radial_layers
 
types::particle_index n_particles
 

Additional Inherited Members

- Protected Member Functions inherited from aspect::Particle::Generator::Interface< dim >
DEAL_II_DEPRECATED std::pair< Particles::internal::LevelInd, Particle< dim > > generate_particle (const Point< dim > &position, const types::particle_index id) const
 
Particles::ParticleIterator< dim > insert_particle_at_position (const Point< dim > &position, const types::particle_index id, Particles::ParticleHandler< dim > &particle_handler) const
 
- Protected Attributes inherited from aspect::Particle::Generator::Interface< dim >
std::mt19937 random_number_generator
 

Detailed Description

template<int dim>
class aspect::Particle::Generator::UniformRadial< dim >

Generate a uniform radial distribution of particles over the entire simulation domain. Uniform here means the particles will be generated with an equal spacing in each spherical spatial dimension, i.e. the particles are created at coordinates that increase linearly with equal spacing in radius, colatitude and longitude around a certain center point. Note that in order to produce a regular distribution the number of generated particles might not exactly match the one specified in the input file.

Definition at line 51 of file uniform_radial.h.

Member Function Documentation

§ generate_particles()

template<int dim>
void aspect::Particle::Generator::UniformRadial< dim >::generate_particles ( Particles::ParticleHandler< dim > &  particle_handler)
overridevirtual

Generate a uniformly distributed set of particles in a circular or spherical subdomain of the global domain.

Parameters
[in,out]particle_handlerThe particle handler into which the generated particles should be inserted.

Reimplemented from aspect::Particle::Generator::Interface< dim >.

§ declare_parameters()

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

Declare the parameters this class takes through input files.

§ parse_parameters()

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

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Particle::Generator::Interface< dim >.

Member Data Documentation

§ P_min

template<int dim>
std::array<double,dim> aspect::Particle::Generator::UniformRadial< dim >::P_min
private

The minimum spherical coordinates of the particle region, i.e. the first radius, colatitude and longitude from the given center position P_center where particles are generated.

Definition at line 90 of file uniform_radial.h.

§ P_max

template<int dim>
std::array<double,dim> aspect::Particle::Generator::UniformRadial< dim >::P_max
private

The maximum spherical coordinates of the particle region, i.e. the last radius, colatitude and longitude from the given center position P_center where particles are generated.

Definition at line 97 of file uniform_radial.h.

§ P_center

template<int dim>
Point<dim> aspect::Particle::Generator::UniformRadial< dim >::P_center
private

The center of the particle region. Defaults to the origin.

Definition at line 102 of file uniform_radial.h.

§ radial_layers

template<int dim>
unsigned int aspect::Particle::Generator::UniformRadial< dim >::radial_layers
private

The number of radial layers of particles that will be generated. In particular this parameter determines the radial spacing between particle layers as Pmax[0] - P_min[0] / radial_layers.

Definition at line 109 of file uniform_radial.h.

§ n_particles

template<int dim>
types::particle_index aspect::Particle::Generator::UniformRadial< dim >::n_particles
private

Number of particles to create in total. To preserve the equal spacing (in spherical coordinates) between particles, the number of actually generated particles can differ slightly from this number.

Definition at line 117 of file uniform_radial.h.

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