Inheritance diagram for aspect::Postprocess::DepthAverage< dim >:

Classes
struct	DataPoint

Public Member Functions
	DepthAverage ()

std::pair< std::string, std::string >	execute (TableHandler &statistics) override

void	parse_parameters (ParameterHandler &prm) override

void	save (std::map< std::string, std::string > &status_strings) const override

void	load (const std::map< std::string, std::string > &status_strings) override

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Public Member Functions inherited from aspect::Postprocess::Interface< dim >
virtual	~Interface ()=default

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 ()=default

virtual void	initialize_simulator (const Simulator< dim > &simulator_object)

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

const TimeStepping::Manager< dim > &	get_timestepping_manager () 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

double	get_end_time () 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::BlockVector &	get_current_linearization_point () const

const LinearAlgebra::BlockVector &	get_solution () const

const LinearAlgebra::BlockVector &	get_old_solution () const

const LinearAlgebra::BlockVector &	get_old_old_solution () const

const LinearAlgebra::BlockVector &	get_reaction_vector () const

const LinearAlgebra::BlockVector &	get_mesh_velocity () const

const DoFHandler< dim > &	get_dof_handler () const

const FiniteElement< dim > &	get_fe () const

const LinearAlgebra::BlockSparseMatrix &	get_system_matrix () const

const LinearAlgebra::BlockSparseMatrix &	get_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

const BoundaryTemperature::Manager< dim > &	get_boundary_temperature_manager () const

const BoundaryHeatFlux::Interface< dim > &	get_boundary_heat_flux () const

bool	has_boundary_composition () const

const BoundaryComposition::Manager< dim > &	get_boundary_composition_manager () const

const BoundaryTraction::Manager< dim > &	get_boundary_traction_manager () const

std::shared_ptr< const InitialTemperature::Manager< dim > >	get_initial_temperature_manager_pointer () const

const InitialTemperature::Manager< dim > &	get_initial_temperature_manager () 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

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::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 Member Functions
void	set_last_output_time (const double current_time)

Private Attributes
double	output_interval

double	last_output_time

std::vector< std::string >	output_formats

unsigned int	n_depth_zones

std::vector< double >	depth_bounds

std::vector< std::string >	variables

std::vector< DataPoint >	entries

Detailed Description

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

A postprocessor that generates depth average output in periodic intervals or every time step.

Definition at line 43 of file depth_average.h.

Constructor & Destructor Documentation

§ DepthAverage()

template<int dim>

aspect::Postprocess::DepthAverage< dim >::DepthAverage ( )

Constructor.

Member Function Documentation

§ execute()

template<int dim>

std::pair<std::string,std::string> aspect::Postprocess::DepthAverage< dim >::execute ( TableHandler & statistics )

overridevirtual

Evaluate the solution and compute the requested depth averages.

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

§ declare_parameters()

template<int dim>

static void aspect::Postprocess::DepthAverage< dim >::declare_parameters ( ParameterHandler & prm )

static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>

void aspect::Postprocess::DepthAverage< dim >::parse_parameters ( ParameterHandler & prm )

overridevirtual

Read the parameters this class declares from the parameter file.

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

§ save()

template<int dim>

void aspect::Postprocess::DepthAverage< dim >::save ( std::map< std::string, std::string > & status_strings ) const

overridevirtual

Save the state of this object.

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

§ load()

template<int dim>

void aspect::Postprocess::DepthAverage< dim >::load ( const std::map< std::string, std::string > & status_strings )

overridevirtual

Restore the state of the object.

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

§ serialize()

template<int dim>

template<class Archive >

void aspect::Postprocess::DepthAverage< 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.

§ set_last_output_time()

template<int dim>

void aspect::Postprocess::DepthAverage< dim >::set_last_output_time ( const double current_time )

private

Set the time output was supposed to be written. In the simplest case, this is the previous last output time plus the interval, but in general we'd like to ensure that it is the largest supposed output time, which is smaller than the current time, to avoid falling behind with last_output_time and having to catch up once the time step becomes larger. This is done after every output.

Member Data Documentation

§ output_interval

template<int dim>

double aspect::Postprocess::DepthAverage< dim >::output_interval

private

Interval between the generation of output in seconds. This parameter is read from the input file and consequently is not part of the state that needs to be saved and restored.

Definition at line 93 of file depth_average.h.

§ last_output_time

template<int dim>

double aspect::Postprocess::DepthAverage< dim >::last_output_time

private

A time (in seconds) the last output has been produced.

Definition at line 98 of file depth_average.h.

§ output_formats

template<int dim>

std::vector<std::string> aspect::Postprocess::DepthAverage< dim >::output_formats

private

The formats in which to produce graphical output. This also determines the extension of the file names to which to write.

Definition at line 104 of file depth_average.h.

§ n_depth_zones

template<int dim>

unsigned int aspect::Postprocess::DepthAverage< dim >::n_depth_zones

private

Number of zones in depth direction over which we are supposed to average.

Definition at line 110 of file depth_average.h.

§ depth_bounds

template<int dim>

std::vector<double> aspect::Postprocess::DepthAverage< dim >::depth_bounds

private

The boundaries of the depth zones. This vector contains exactly n_depth_zones + 1 entries, and entries i and i+1 represent the lower and upper depth bound of zone i.

Definition at line 118 of file depth_average.h.

§ variables

template<int dim>

std::vector<std::string> aspect::Postprocess::DepthAverage< dim >::variables

private

List of the quantities to calculate for each depth zone.

Definition at line 123 of file depth_average.h.

§ entries

template<int dim>

std::vector<DataPoint> aspect::Postprocess::DepthAverage< dim >::entries

private

An array of all the past values

Definition at line 140 of file depth_average.h.

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

/home/bob/source/include/aspect/postprocess/depth_average.h

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

§ DepthAverage()

Member Function Documentation

§ execute()

§ declare_parameters()

§ parse_parameters()

§ save()

§ load()

§ serialize()

§ set_last_output_time()

Member Data Documentation

§ output_interval

§ last_output_time

§ output_formats

§ n_depth_zones

§ depth_bounds

§ variables

§ entries

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