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

Public Member Functions

 AsciiData ()
 
void initialize () override
 
double initial_composition (const Point< dim > &position, const unsigned int n_comp) const override
 
void parse_parameters (ParameterHandler &prm) override
 
- Public Member Functions inherited from aspect::InitialComposition::Interface< dim >
virtual ~Interface ()=default
 
- 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)
 
template<typename PostprocessorType >
PostprocessorType * find_postprocessor () const
 
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
 
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
 
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
 
DEAL_II_DEPRECATED const BoundaryTemperature::Interface< dim > & get_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
 
DEAL_II_DEPRECATED const BoundaryComposition::Interface< dim > & get_boundary_composition () const
 
const BoundaryComposition::Manager< dim > & get_boundary_composition_manager () const
 
const std::map< types::boundary_id, std::unique_ptr< BoundaryTraction::Interface< dim > > > & get_boundary_traction () const
 
DEAL_II_DEPRECATED const InitialTemperature::Interface< dim > & get_initial_temperature () const
 
std::shared_ptr< const InitialTemperature::Manager< dim > > get_initial_temperature_manager_pointer () const
 
const InitialTemperature::Manager< dim > & get_initial_temperature_manager () const
 
DEAL_II_DEPRECATED const InitialComposition::Interface< dim > & get_initial_composition () 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
 
template<typename PostprocessorType >
DEAL_II_DEPRECATED PostprocessorType * find_postprocessor () 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::InitialComposition::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::unique_ptr< Utilities::AsciiDataInitial< dim > > ascii_data_initial
 
std::unique_ptr< Utilities::AsciiDataInitial< dim, 3 > > ascii_data_slice
 
bool slice_data
 
Tensor< 1, 3 > first_point_on_slice
 
Tensor< 1, 3 > second_point_on_slice
 
Tensor< 2, 3 > rotation_matrix
 

Detailed Description

template<int dim>
class aspect::InitialComposition::AsciiData< dim >

A class that implements the prescribed compositional fields determined from a AsciiData input file.

Definition at line 44 of file ascii_data.h.

Constructor & Destructor Documentation

§ AsciiData()

template<int dim>
aspect::InitialComposition::AsciiData< dim >::AsciiData ( )

Empty Constructor.

Member Function Documentation

§ initialize()

template<int dim>
void aspect::InitialComposition::AsciiData< dim >::initialize ( )
overridevirtual

Initialization function. This function is called once at the beginning of the program. Checks preconditions.

Reimplemented from aspect::InitialComposition::Interface< dim >.

§ initial_composition()

template<int dim>
double aspect::InitialComposition::AsciiData< dim >::initial_composition ( const Point< dim > &  position,
const unsigned int  n_comp 
) const
overridevirtual

Return the initial composition as a function of position. For the current class, this function returns value from the text files.

Implements aspect::InitialComposition::Interface< dim >.

§ declare_parameters()

template<int dim>
static void aspect::InitialComposition::AsciiData< dim >::declare_parameters ( ParameterHandler &  prm)
static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>
void aspect::InitialComposition::AsciiData< dim >::parse_parameters ( ParameterHandler &  prm)
overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::InitialComposition::Interface< dim >.

Member Data Documentation

§ ascii_data_initial

template<int dim>
std::unique_ptr<Utilities::AsciiDataInitial<dim> > aspect::InitialComposition::AsciiData< dim >::ascii_data_initial
private

The dataset that contains the initial composition. This member variable is used in case the dataset has the same spatial dimensions as the model.

Definition at line 86 of file ascii_data.h.

§ ascii_data_slice

template<int dim>
std::unique_ptr<Utilities::AsciiDataInitial<dim,3> > aspect::InitialComposition::AsciiData< dim >::ascii_data_slice
private

The dataset that contains the initial composition. This member variable is used in case the dataset has a higher spatial dimension than the model, and only a slice of the dataset is used.

Definition at line 94 of file ascii_data.h.

§ slice_data

template<int dim>
bool aspect::InitialComposition::AsciiData< dim >::slice_data
private

Whether to use a dataset that has the same spatial dimensions as the model or not. If true only a slice of the dataset is used.

Definition at line 100 of file ascii_data.h.

§ first_point_on_slice

template<int dim>
Tensor<1,3> aspect::InitialComposition::AsciiData< dim >::first_point_on_slice
private

The two points that define the location of the slice.

Definition at line 105 of file ascii_data.h.

§ second_point_on_slice

template<int dim>
Tensor<1,3> aspect::InitialComposition::AsciiData< dim >::second_point_on_slice
private

Definition at line 106 of file ascii_data.h.

§ rotation_matrix

template<int dim>
Tensor<2,3> aspect::InitialComposition::AsciiData< dim >::rotation_matrix
private

The matrix that describes the rotation by which a 2D model needs to be transformed to a plane that contains the origin and the two prescribed points given in the input.

Definition at line 113 of file ascii_data.h.


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