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

Public Member Functions

 AsciiData ()
 
void initialize ()
 
void update ()
 
double boundary_composition (const types::boundary_id boundary_indicator, const Point< dim > &position, const unsigned int compositional_field) const
 
void parse_parameters (ParameterHandler &prm)
 
- Public Member Functions inherited from aspect::Utilities::AsciiDataBoundary< dim >
 AsciiDataBoundary ()
 
virtual void initialize (const std::set< types::boundary_id > &boundary_ids, const unsigned int components)
 
void update ()
 
double get_data_component (const types::boundary_id boundary_indicator, const Point< dim > &position, const unsigned int component) const
 
double get_maximum_component_value (const types::boundary_id boundary_indicator, const unsigned int component) const
 
void parse_parameters (ParameterHandler &prm, const std::string &subsection_name="Ascii data model")
 
- 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::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
 
- Public Member Functions inherited from aspect::BoundaryComposition::Interface< dim >
virtual ~Interface ()
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 
- Static Public Member Functions inherited from aspect::Utilities::AsciiDataBoundary< 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::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::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)
 
- Static Public Member Functions inherited from aspect::BoundaryComposition::Interface< dim >
static void declare_parameters (ParameterHandler &prm)
 

Additional Inherited Members

- Public Attributes inherited from aspect::Utilities::AsciiDataBase< dim >
std::string data_directory
 
std::string data_file_name
 
double scale_factor
 
- Protected Member Functions inherited from aspect::Utilities::AsciiDataBoundary< dim >
std::array< unsigned int, dim-1 > get_boundary_dimensions (const types::boundary_id boundary_id) const
 
void update_data (const types::boundary_id boundary_id, const bool reload_both_files)
 
void end_time_dependence ()
 
std::string create_filename (const int filenumber, const types::boundary_id boundary_id) const
 
- Protected Attributes inherited from aspect::Utilities::AsciiDataBoundary< dim >
int current_file_number
 
double first_data_file_model_time
 
int first_data_file_number
 
bool decreasing_file_order
 
double data_file_time_step
 
double time_weight
 
bool time_dependent
 
std::map< types::boundary_id, std::unique_ptr< aspect::Utilities::AsciiDataLookup< dim-1 > > > lookups
 
std::map< types::boundary_id, std::unique_ptr< aspect::Utilities::AsciiDataLookup< dim-1 > > > old_lookups
 

Detailed Description

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

A class that implements prescribed boundary conditions determined from a AsciiData input file.

Definition at line 44 of file ascii_data.h.

Constructor & Destructor Documentation

§ AsciiData()

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

Empty Constructor.

Member Function Documentation

§ initialize()

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

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

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

§ update()

template<int dim>
void aspect::BoundaryComposition::AsciiData< dim >::update ( )
virtual

A function that is called at the beginning of each time step. For the current plugin, this function loads the next data files if necessary and outputs a warning if the end of the set of data files is reached.

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

§ boundary_composition()

template<int dim>
double aspect::BoundaryComposition::AsciiData< dim >::boundary_composition ( const types::boundary_id  boundary_indicator,
const Point< dim > &  position,
const unsigned int  compositional_field 
) const
virtual

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

Return the composition that is to hold at a particular position on the boundary of the domain.

Parameters
boundary_indicatorThe boundary indicator of the part of the boundary of the domain on which the point is located at which we are requesting the composition.
positionThe position of the point at which we ask for the composition.
compositional_fieldThe index of the compositional field between 0 and parameters.n_compositional_fields.
Returns
Boundary value of the compositional field compositional_field at the position position.

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

§ declare_parameters()

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

Declare the parameters this class takes through input files.

§ parse_parameters()

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

Read the parameters this class declares from the parameter file.

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


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