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

Public Member Functions

 CpoBinghamAverage ()
 
void initialize () override
 
void initialize_one_particle_property (const Point< dim > &position, std::vector< double > &particle_properties) const override
 
void update_one_particle_property (const unsigned int data_position, const Point< dim > &position, const Vector< double > &solution, const std::vector< Tensor< 1, dim >> &gradients, const ArrayView< double > &particle_properties) const override
 
UpdateTimeFlags need_update () const override
 
UpdateFlags get_needed_update_flags () const override
 
std::vector< std::pair< std::string, unsigned int > > get_property_information () const override
 
std::array< std::array< double, 3 >, 3 > compute_bingham_average (std::vector< Tensor< 2, 3 >> matrices) const
 
void parse_parameters (ParameterHandler &prm) override
 
- Public Member Functions inherited from aspect::Particle::Property::Interface< dim >
virtual ~Interface ()=default
 
virtual void update_particle_property (const unsigned int data_position, const Vector< double > &solution, const std::vector< Tensor< 1, dim >> &gradients, typename ParticleHandler< dim >::particle_iterator &particle) const
 
virtual InitializationModeForLateParticles late_initialization_mode () const
 
- 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
 
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::Property::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

unsigned int cpo_data_position
 
std::unique_ptr< const Particle::Property::CrystalPreferredOrientation< dim > > cpo_particle_property
 
std::mt19937 random_number_generator
 
unsigned int random_number_seed
 
unsigned int n_grains
 
unsigned int n_minerals
 
unsigned int n_samples
 

Detailed Description

template<int dim>
class aspect::Particle::Property::CpoBinghamAverage< dim >

Computes the Bingham average of the CPO particle properties. See https://courses.eas.ualberta.ca/eas421/lecturepages/orientation.html for more info.

The layout of the data vector per particle is the following (note that for this plugin the following dim's are always 3): 1 averaged a axis of olivine -> 3 (dim) doubles, starts at: data_position + 1, 2 averaged b axis of olivine -> 3 (dim) doubles, starts at: data_position + 4 3 averaged c axis of olivine -> 3 (dim) doubles, starts at: data_position + 7 4 averaged a axis of enstatite -> 3 (dim) doubles, starts at: data_position + 10 5 averaged b axis of enstatite -> 3 (dim) doubles, starts at: data_position + 13 6 averaged c axis of enstatite -> 3 (dim) doubles, starts at: data_position + 16

Definition at line 59 of file cpo_bingham_average.h.

Constructor & Destructor Documentation

§ CpoBinghamAverage()

constructor

Member Function Documentation

§ initialize()

template<int dim>
void aspect::Particle::Property::CpoBinghamAverage< dim >::initialize ( )
overridevirtual

Initialization function. This function is called once at the beginning of the program after parse_parameters is run.

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

§ initialize_one_particle_property()

template<int dim>
void aspect::Particle::Property::CpoBinghamAverage< dim >::initialize_one_particle_property ( const Point< dim > &  position,
std::vector< double > &  particle_properties 
) const
overridevirtual

Initialization function. This function is called once at the creation of every particle for every property to initialize its value.

Parameters
[in]positionThe current particle position.
[in,out]particle_propertiesThe properties of the particle that is initialized within the call of this function. The purpose of this function should be to extend this vector by a number of properties.

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

§ update_one_particle_property()

template<int dim>
void aspect::Particle::Property::CpoBinghamAverage< dim >::update_one_particle_property ( const unsigned int  data_position,
const Point< dim > &  position,
const Vector< double > &  solution,
const std::vector< Tensor< 1, dim >> &  gradients,
const ArrayView< double > &  particle_properties 
) const
overridevirtual

Update function. This function is called every time an update is request by need_update() for every particle for every property.

Parameters
[in]data_positionAn unsigned integer that denotes which component of the particle property vector is associated with the current property. For properties that own several components it denotes the first component of this property, all other components fill consecutive entries in the particle_properties vector.
[in]positionThe current particle position.
[in]solutionThe values of the solution variables at the current particle position.
[in]gradientsThe gradients of the solution variables at the current particle position.
[in,out]particle_propertiesThe properties of the particle that is updated within the call of this function.

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

§ need_update()

template<int dim>
UpdateTimeFlags aspect::Particle::Property::CpoBinghamAverage< dim >::need_update ( ) const
overridevirtual

This implementation tells the particle manager that we need to update particle properties every time step.

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

§ get_needed_update_flags()

template<int dim>
UpdateFlags aspect::Particle::Property::CpoBinghamAverage< dim >::get_needed_update_flags ( ) const
overridevirtual

Return which data has to be provided to update the property. The integrated strains needs the gradients of the velocity.

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

§ get_property_information()

template<int dim>
std::vector<std::pair<std::string, unsigned int> > aspect::Particle::Property::CpoBinghamAverage< dim >::get_property_information ( ) const
overridevirtual

Set up the information about the names and number of components this property requires.

Returns
A vector that contains pairs of the property names and the number of components this property plugin defines.

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

§ compute_bingham_average()

template<int dim>
std::array<std::array<double,3>,3> aspect::Particle::Property::CpoBinghamAverage< dim >::compute_bingham_average ( std::vector< Tensor< 2, 3 >>  matrices) const

Computes the Bingham average. This is a way to average directions. The method comes from https://courses.eas.ualberta.ca/eas421/lecturepages/orientation.html, where it is explained with the anology that each vector/pole has a weight on a sphere. This method allows to find the moment of inertia for spinning that sphere. Here we just use it to get three averaged axis associated with the densest clustering of points for each axis. the a to c axis vectors are stored in the first to last array respectively.

§ declare_parameters()

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

Declare the parameters this class takes through input files.

§ parse_parameters()

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

Read the parameters this class declares from the parameter file.

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

Member Data Documentation

§ cpo_data_position

template<int dim>
unsigned int aspect::Particle::Property::CpoBinghamAverage< dim >::cpo_data_position
private

stores the position of the cpo data in the particle property vector

Definition at line 169 of file cpo_bingham_average.h.

§ cpo_particle_property

template<int dim>
std::unique_ptr<const Particle::Property::CrystalPreferredOrientation<dim> > aspect::Particle::Property::CpoBinghamAverage< dim >::cpo_particle_property
private

A pointer to the crystal preferred orientation particle property. Avoids repeated searches for that property.

Definition at line 175 of file cpo_bingham_average.h.

§ random_number_generator

template<int dim>
std::mt19937 aspect::Particle::Property::CpoBinghamAverage< dim >::random_number_generator
mutableprivate

Random number generator. For reproducibility of tests it is initialized in the constructor with a constant plus the MPI rank.

Definition at line 181 of file cpo_bingham_average.h.

§ random_number_seed

template<int dim>
unsigned int aspect::Particle::Property::CpoBinghamAverage< dim >::random_number_seed
private

the random number generator seed used to initialize the random number generator.

Definition at line 186 of file cpo_bingham_average.h.

§ n_grains

template<int dim>
unsigned int aspect::Particle::Property::CpoBinghamAverage< dim >::n_grains
private

Number of grains

Definition at line 191 of file cpo_bingham_average.h.

§ n_minerals

template<int dim>
unsigned int aspect::Particle::Property::CpoBinghamAverage< dim >::n_minerals
private

Number of minerals

Definition at line 196 of file cpo_bingham_average.h.

§ n_samples

template<int dim>
unsigned int aspect::Particle::Property::CpoBinghamAverage< dim >::n_samples
private

when doing the random draw volume weighting, this sets how many samples are taken.

Definition at line 201 of file cpo_bingham_average.h.


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