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

Public Member Functions

std::list< std::pair< std::string, std::string > > execute (TableHandler &statistics)
 
template<typename PostprocessorType >
DEAL_II_DEPRECATED PostprocessorType * find_postprocessor () const
 
template<typename PostprocessorType >
bool has_matching_postprocessor () const
 
template<typename PostprocessorType >
const PostprocessorType & get_matching_postprocessor () const
 
void parse_parameters (ParameterHandler &prm)
 
template<class Archive >
void save (Archive &ar, const unsigned int version) const
 
template<class Archive >
void load (Archive &ar, const unsigned int version)
 
 DeclException1 (ExcPostprocessorNameNotFound, std::string,<< "Could not find entry <"<< arg1<< "> among the names of registered postprocessors.")
 
template<typename PostprocessorType >
PostprocessorType * find_postprocessor () 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
 
DEAL_II_DEPRECATED const std::map< types::boundary_id, std::shared_ptr< BoundaryVelocity::Interface< dim > > > get_prescribed_boundary_velocity () 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 void register_postprocessor (const std::string &name, const std::string &description, void(*declare_parameters_function)(ParameterHandler &), Interface< dim > *(*factory_function)())
 
static void write_plugin_graph (std::ostream &output_stream)
 
- 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::vector< std::shared_ptr< Interface< dim > > > postprocessors
 

Detailed Description

template<int dim>
class aspect::Postprocess::Manager< dim >

A class that manages all objects that provide functionality to postprocess solutions. It declares run time parameters for input files, reads their values from such an input file, manages a list of all postprocessors selected in the input file, and upon request through the execute() function calls them in turn.

Definition at line 136 of file simulator_access.h.

Member Function Documentation

§ execute()

template<int dim>
std::list<std::pair<std::string,std::string> > aspect::Postprocess::Manager< dim >::execute ( TableHandler statistics)

Execute all of the postprocessor objects that have been requested in the input file. These objects also fill the contents of the statistics object.

The function returns a concatenation of the text returned by the individual postprocessors.

§ find_postprocessor() [1/2]

template<int dim>
template<typename PostprocessorType >
DEAL_II_DEPRECATED PostprocessorType* aspect::Postprocess::Manager< dim >::find_postprocessor ( ) const

Go through the list of all postprocessors that have been selected in the input file (and are consequently currently active) and see if one of them has the desired type specified by the template argument. If so, return a pointer to it. If no postprocessor is active that matches the given type, return a nullptr.

Deprecated:
Use has_matching_postprocessor() and get_matching_postprocessor() instead.

§ has_matching_postprocessor()

template<int dim>
template<typename PostprocessorType >
bool aspect::Postprocess::Manager< dim >::has_matching_postprocessor ( ) const
inline

Go through the list of all postprocessors that have been selected in the input file (and are consequently currently active) and return true if one of them has the desired type specified by the template argument.

Definition at line 417 of file interface.h.

§ get_matching_postprocessor()

template<int dim>
template<typename PostprocessorType >
const PostprocessorType & aspect::Postprocess::Manager< dim >::get_matching_postprocessor ( ) const
inline

Go through the list of all postprocessors that have been selected in the input file (and are consequently currently active) and see if one of them has the type specified by the template argument or can be casted to that type. If so, return a reference to it. If no postprocessor is active that matches the given type, throw an exception.

Definition at line 434 of file interface.h.

References AssertThrow, and ExcMessage().

§ declare_parameters()

template<int dim>
static void aspect::Postprocess::Manager< dim >::declare_parameters ( ParameterHandler prm)
static

Declare the parameters of all known postprocessors, as well as of ones this class has itself.

§ parse_parameters()

template<int dim>
void aspect::Postprocess::Manager< dim >::parse_parameters ( ParameterHandler prm)

Read the parameters this class declares from the parameter file. This determines which postprocessor objects will be created; then let these objects read their parameters as well.

§ save()

template<int dim>
template<class Archive >
void aspect::Postprocess::Manager< dim >::save ( Archive &  ar,
const unsigned int  version 
) const

Write the data of this object to a stream for the purpose of serialization.

Definition at line 362 of file interface.h.

References aspect::Postprocess::Manager< dim >::save().

Referenced by aspect::Postprocess::Manager< dim >::save().

§ load()

template<int dim>
template<class Archive >
void aspect::Postprocess::Manager< dim >::load ( Archive &  ar,
const unsigned int  version 
)

Read the data of this object from a stream for the purpose of serialization.

Definition at line 379 of file interface.h.

References aspect::Postprocess::Manager< dim >::load().

Referenced by aspect::Postprocess::Manager< dim >::load().

§ register_postprocessor()

template<int dim>
static void aspect::Postprocess::Manager< dim >::register_postprocessor ( const std::string &  name,
const std::string &  description,
void(*)(ParameterHandler &)  declare_parameters_function,
Interface< dim > *(*)()  factory_function 
)
static

A function that is used to register postprocessor objects in such a way that the Manager can deal with all of them without having to know them by name. This allows the files in which individual postprocessors are implement to register these postprocessors, rather than also having to modify the Manager class by adding the new postprocessor class.

Parameters
nameThe name under which this postprocessor is to be called in parameter files.
descriptionA text description of what this model does and that will be listed in the documentation of the parameter file.
declare_parameters_functionA pointer to a function that declares the parameters for this postprocessor.
factory_functionA pointer to a function that creates such a postprocessor object and returns a pointer to it.

§ write_plugin_graph()

template<int dim>
static void aspect::Postprocess::Manager< dim >::write_plugin_graph ( std::ostream &  output_stream)
static

For the current plugin subsystem, write a connection graph of all of the plugins we know about, in the format that the programs dot and neato understand. This allows for a visualization of how all of the plugins that ASPECT knows about are interconnected, and connect to other parts of the ASPECT code.

Parameters
output_streamThe stream to write the output to.

§ DeclException1()

template<int dim>
aspect::Postprocess::Manager< dim >::DeclException1 ( ExcPostprocessorNameNotFound  ,
std::string   
)

Exception.

§ find_postprocessor() [2/2]

template<int dim>
template<typename PostprocessorType >
PostprocessorType* aspect::Postprocess::Manager< dim >::find_postprocessor ( ) const
inline

Definition at line 401 of file interface.h.

Member Data Documentation

§ postprocessors

template<int dim>
std::vector<std::shared_ptr<Interface<dim> > > aspect::Postprocess::Manager< dim >::postprocessors
private

A list of postprocessor objects that have been requested in the parameter file.

Definition at line 354 of file interface.h.


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