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

Public Member Functions

 AsciiData ()
 
virtual void initialize ()
 
virtual bool is_initialized () const
 
virtual double temperature (const Point< dim > &p) const
 
virtual double pressure (const Point< dim > &p) const
 
virtual double density (const Point< dim > &p) const
 
virtual double density_derivative (const Point< dim > &p) const
 
void parse_parameters (ParameterHandler &prm)
 
- Public Member Functions inherited from aspect::Utilities::AsciiDataProfile< dim >
 AsciiDataProfile ()
 
virtual void initialize (const MPI_Comm &communicator)
 
double get_data_component (const Point< 1 > &position, const unsigned int component) const
 
std::vector< std::string > get_column_names () const
 
unsigned int get_column_index_from_name (const std::string &column_name) const
 
unsigned int maybe_get_column_index_from_name (const std::string &column_name) const
 
std::string get_column_name_from_index (const unsigned int column_index) const
 
- Public Member Functions inherited from aspect::Utilities::AsciiDataBase< dim >
 AsciiDataBase ()
 
void parse_parameters (ParameterHandler &prm, const std::string &subsection_name="Ascii data model")
 
- Public Member Functions inherited from aspect::AdiabaticConditions::Interface< dim >
virtual ~Interface ()
 
virtual void update ()
 
virtual void get_adiabatic_temperature_profile (std::vector< double > &values) const
 
virtual void get_adiabatic_pressure_profile (std::vector< double > &values) const
 
virtual void get_adiabatic_density_profile (std::vector< double > &values) const
 
virtual void get_adiabatic_density_derivative_profile (std::vector< double > &values) const
 
- Public Member Functions inherited from aspect::SimulatorAccess< dim >
 SimulatorAccess ()
 
 SimulatorAccess (const Simulator< dim > &simulator_object)
 
virtual ~SimulatorAccess ()
 
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
 
TimerOutputget_computing_timer () const
 
const ConditionalOStreamget_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
 
void compute_material_model_input_values (const LinearAlgebra::BlockVector &input_solution, const FEValuesBase< dim, dim > &input_finite_element_values, const typename DoFHandler< dim >::active_cell_iterator &cell, const bool compute_strainrate, MaterialModel::MaterialModelInputs< dim > &material_model_inputs) 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
 
const InitialTemperature::Manager< dim > & get_initial_temperature_manager () const
 
DEAL_II_DEPRECATED const InitialComposition::Interface< dim > & get_initial_composition () 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_free_surface_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 WorldBuilder::World & get_world_builder () const
 
const FreeSurfaceHandler< dim > & get_free_surface_handler () const
 
const LateralAveraging< dim > & get_lateral_averaging () const
 
const ConstraintMatrix & get_current_constraints () const
 
bool simulator_is_initialized () const
 
double get_pressure_scaling () const
 
bool pressure_rhs_needs_compatibility_modification () const
 
bool model_has_prescribed_stokes_solution () const
 
TableHandlerget_statistics_object () const
 
template<typename PostprocessorType >
DEAL_II_DEPRECATED PostprocessorType * find_postprocessor () const
 
const Postprocess::Manager< dim > & get_postprocess_manager () const
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 
- Static Public Member Functions inherited from aspect::Utilities::AsciiDataBase< dim >
static void declare_parameters (ParameterHandler &prm, const std::string &default_directory, const std::string &default_filename, const std::string &subsection_name="Ascii data model")
 
- Static Public Member Functions inherited from aspect::AdiabaticConditions::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

bool initialized
 
unsigned int temperature_index
 
unsigned int pressure_index
 
unsigned int density_index
 

Additional Inherited Members

- Public Attributes inherited from aspect::Utilities::AsciiDataBase< dim >
std::string data_directory
 
std::string data_file_name
 
double scale_factor
 
- Protected Attributes inherited from aspect::Utilities::AsciiDataProfile< dim >
std::unique_ptr< aspect::Utilities::AsciiDataLookup< 1 > > lookup
 

Detailed Description

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

A simple class that reads adiabatic conditions from a file.

Definition at line 42 of file ascii_data.h.

Constructor & Destructor Documentation

§ AsciiData()

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

Constructor. Initialize variables.

Member Function Documentation

§ initialize()

template<int dim>
virtual void aspect::AdiabaticConditions::AsciiData< dim >::initialize ( )
virtual

Initialization function. Because this function is called after initializing the SimulatorAccess, all of the necessary information is available to calculate the adiabatic profile. It computes the adiabatic conditions along a vertical transect of the geometry based on the given material model and other quantities.

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

§ is_initialized()

template<int dim>
virtual bool aspect::AdiabaticConditions::AsciiData< dim >::is_initialized ( ) const
virtual

Some plugins need to know whether the adiabatic conditions are already calculated. This is for example the case for the simple compressible material model, which uses the adiabatic temperature as reference temperature to calculate the density. For the calculation of the adiabatic conditions this functionality is simply switched off, because we are always on the reference profile. This way the plugin behaves differently at initialization time of the adiabatic conditions and during the main model run.

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

§ temperature()

template<int dim>
virtual double aspect::AdiabaticConditions::AsciiData< dim >::temperature ( const Point< dim > &  p) const
virtual

Return the adiabatic temperature at a given point of the domain.

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

§ pressure()

template<int dim>
virtual double aspect::AdiabaticConditions::AsciiData< dim >::pressure ( const Point< dim > &  p) const
virtual

Return the adiabatic pressure at a given point of the domain.

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

§ density()

template<int dim>
virtual double aspect::AdiabaticConditions::AsciiData< dim >::density ( const Point< dim > &  p) const
virtual

Return the reference density at a given point of the domain.

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

§ density_derivative()

template<int dim>
virtual double aspect::AdiabaticConditions::AsciiData< dim >::density_derivative ( const Point< dim > &  p) const
virtual

Return the derivative of the density with respect to depth at the given point p.

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

§ declare_parameters()

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

Declare the parameters for the input files.

§ parse_parameters()

template<int dim>
void aspect::AdiabaticConditions::AsciiData< dim >::parse_parameters ( ParameterHandler prm)
virtual

Read the parameters from the parameter file.

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

Member Data Documentation

§ initialized

template<int dim>
bool aspect::AdiabaticConditions::AsciiData< dim >::initialized
private

Whether the adiabatic conditions are already calculated. This is important for plugins that are used by the adiabatic conditions but also depend on the adiabatic conditions. This way they can behave differently in initialization and model run.

Definition at line 118 of file ascii_data.h.

§ temperature_index

template<int dim>
unsigned int aspect::AdiabaticConditions::AsciiData< dim >::temperature_index
private

The column indices of the temperature, pressure, and density column in the data file.

Definition at line 124 of file ascii_data.h.

§ pressure_index

template<int dim>
unsigned int aspect::AdiabaticConditions::AsciiData< dim >::pressure_index
private

Definition at line 125 of file ascii_data.h.

§ density_index

template<int dim>
unsigned int aspect::AdiabaticConditions::AsciiData< dim >::density_index
private

Definition at line 126 of file ascii_data.h.


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