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

Public Member Functions

 CoreStatistics ()
 
virtual void parse_parameters (ParameterHandler &prm)
 
virtual std::pair< std::string, std::string > execute (TableHandler &statistics)
 
const BoundaryTemperature::internal::CoreDataget_core_data () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
virtual void save (std::map< std::string, std::string > &status_strings) const
 
virtual void load (const std::map< std::string, std::string > &status_strings)
 
- Public Member Functions inherited from aspect::Postprocess::Interface< dim >
virtual ~Interface ()
 
virtual void initialize ()
 
virtual void update ()
 
virtual std::list< std::string > required_other_postprocessors () 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::shared_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 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::Postprocess::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 excess_entropy_only
 
struct BoundaryTemperature::internal::CoreData core_data
 

Detailed Description

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

A postprocessor that computes some statistics about the dynamic core.

Definition at line 41 of file core_statistics.h.

Constructor & Destructor Documentation

§ CoreStatistics()

template<int dim>
aspect::Postprocess::CoreStatistics< dim >::CoreStatistics ( )

Member Function Documentation

§ declare_parameters()

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

Declare the parameters this class takes through input files.

§ parse_parameters()

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

Read the parameters this class declares from the parameter file.

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

§ execute()

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

Execute this postprocessor. Derived classes will implement this function to do whatever they want to do to evaluate the solution at the current time step.

Parameters
[in,out]statisticsAn object that contains statistics that are collected throughout the simulation and that will be written to an output file at the end of each time step. Postprocessors may deposit data in these tables for later visualization or further processing.
Returns
A pair of strings that will be printed to the screen after running the postprocessor in two columns; typically the first column contains a description of what the data is and the second contains a numerical value of this data. If there is nothing to print, simply return two empty strings.

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

§ get_core_data()

template<int dim>
const BoundaryTemperature::internal::CoreData& aspect::Postprocess::CoreStatistics< dim >::get_core_data ( ) const

Export core data stored in this object. Doing this only because the boundary temperature doesn't allowed to store restart data there. So we store the data needed for restart here and exported to boundary temperature object if required.

§ serialize()

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

Serialize the contents of this class as far as they are not read from input parameter files.

§ save()

template<int dim>
virtual void aspect::Postprocess::CoreStatistics< dim >::save ( std::map< std::string, std::string > &  status_strings) const
virtual

Save the state of this object.

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

§ load()

template<int dim>
virtual void aspect::Postprocess::CoreStatistics< dim >::load ( const std::map< std::string, std::string > &  status_strings)
virtual

Restore the state of the object.

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

Member Data Documentation

§ excess_entropy_only

template<int dim>
bool aspect::Postprocess::CoreStatistics< dim >::excess_entropy_only
private

Controls whether output the total excess entropy or the individual entropy terms (i.e. entropy for specific heat, radioactive heating, gravitational contribution, and adiabatic contribution).

Definition at line 96 of file core_statistics.h.

§ core_data

template<int dim>
struct BoundaryTemperature::internal::CoreData aspect::Postprocess::CoreStatistics< dim >::core_data
private

Stores the core data from boundary temperature.

Definition at line 101 of file core_statistics.h.


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