Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Parameters::PostProcessing< dim > Class Template Reference

#include <parameters.h>

Classes

struct  IsocontourBoundingBoxes
struct  ProbingPoints

Public Member Functions

void declare_parameters (ParameterHandler &prm)
void parse_parameters (ParameterHandler &prm)

Public Attributes

IsocontourBoundingBoxes isocontour_bounding_boxes
ProbingPoints probing_points
Verbosity verbosity = Verbosity::quiet
bool calculate_kinetic_energy = false
bool calculate_enstrophy = false
bool calculate_pressure_power = false
bool calculate_viscous_dissipation = false
bool calculate_apparent_viscosity = false
bool calculate_average_velocities = false
bool calculate_average_temp_and_hf = false
bool calculate_pressure_drop = false
unsigned int inlet_boundary_id = 0
unsigned int outlet_boundary_id = 1
bool calculate_flow_rate = false
bool calculate_tracer_flow_rate = false
double initial_time_for_average_velocities = 0.0
double initial_time_for_average_temp_and_hf = 0.0
unsigned int calculation_frequency = 1
unsigned int output_frequency = 1
std::string kinetic_energy_output_name = "kinetic_energy"
std::string pressure_drop_output_name = "pressure_drop"
std::string flow_rate_output_name = "flow_rate"
std::string tracer_flow_rate_output_name = "tracer_flow_rate"
std::string enstrophy_output_name = "enstrophy"
std::string pressure_power_output_name = "pressure_power"
std::string viscous_dissipation_output_name = "viscous_dissipation"
std::string apparent_viscosity_output_name = "apparent_viscosity"
bool calculate_tracer_statistics = false
std::string tracer_output_name = "tracer_statistics"
bool calculate_temperature_statistics = false
std::string temperature_output_name = "temperature_statistics"
bool calculate_algebraic_melt_volume = false
std::string algebraic_melt_volume_output_name = "melt_volume_alge"
bool calculate_geometric_melt_volume = false
std::string geometric_melt_volume_output_name = "melt_volume_geo"
Parameters::FluidIndicator monitored_fluid_with_phase_change
double melting_temperature = 0.
bool calculate_heat_flux = false
std::string heat_flux_output_name = "heat_flux"
Parameters::FluidIndicator postprocessed_fluid
bool calculate_barycenter = false
std::string barycenter_output_name = "barycenter_information"
bool calculate_phase_statistics = false
std::string phase_output_name = "phase_statistics"
bool calculate_mass_conservation = true
std::string mass_conservation_output_name = "mass_conservation_information"
bool calculate_phase_energy = false
std::string phase_energy_output_name = "phase_energy"
bool calculate_phase_volumes = false
std::string phase_volumes_output_name = "phase_volumes"
bool output_q_criterion = true
bool output_vorticity = true
bool output_velocity_gradient = true

Detailed Description

template<int dim>
class Parameters::PostProcessing< dim >

Postprocessing - Defines the parameters for the post-processing. In Lethe, post-processing implies the calculation of quantities derived from the principal variables. For example, the integral kinetic energy or the integral enstrophy.

Template Parameters
dimDenotes the number of spatial dimensions.

Definition at line 1291 of file parameters.h.

Member Function Documentation

◆ declare_parameters()

template<int dim>
void Parameters::PostProcessing< dim >::declare_parameters ( ParameterHandler & prm)

Declare the parameters.

Parameters
[in,out]prmParameterHandler object.

Definition at line 2646 of file parameters.cc.

References algebraic_melt_volume_output_name, apparent_viscosity_output_name, barycenter_output_name, calculate_algebraic_melt_volume, calculate_apparent_viscosity, calculate_average_temp_and_hf, calculate_average_velocities, calculate_barycenter, calculate_enstrophy, calculate_flow_rate, calculate_geometric_melt_volume, calculate_heat_flux, calculate_kinetic_energy, calculate_mass_conservation, calculate_phase_energy, calculate_phase_statistics, calculate_phase_volumes, calculate_pressure_drop, calculate_pressure_power, calculate_temperature_statistics, calculate_tracer_flow_rate, calculate_tracer_statistics, calculate_viscous_dissipation, calculation_frequency, declare_enum_entry(), Parameters::deprecated_fluid_indicator_names(), Parameters::deprecated_verbosity_names(), enstrophy_output_name, flow_rate_output_name, geometric_melt_volume_output_name, heat_flux_output_name, initial_time_for_average_temp_and_hf, initial_time_for_average_velocities, inlet_boundary_id, isocontour_bounding_boxes, kinetic_energy_output_name, mass_conservation_output_name, melting_temperature, monitored_fluid_with_phase_change, outlet_boundary_id, output_frequency, output_q_criterion, output_velocity_gradient, output_vorticity, phase_energy_output_name, phase_output_name, phase_volumes_output_name, postprocessed_fluid, pressure_drop_output_name, pressure_power_output_name, probing_points, Parameters::quiet_or_verbose(), Parameters::single_fluid_indicators(), temperature_output_name, tracer_flow_rate_output_name, tracer_output_name, verbosity, and viscous_dissipation_output_name.

◆ parse_parameters()

template<int dim>
void Parameters::PostProcessing< dim >::parse_parameters ( ParameterHandler & prm)

Parse the parameters.

Parameters
[in]prmThe ParameterHandler.

Definition at line 2967 of file parameters.cc.

References algebraic_melt_volume_output_name, apparent_viscosity_output_name, barycenter_output_name, calculate_algebraic_melt_volume, calculate_apparent_viscosity, calculate_average_temp_and_hf, calculate_average_velocities, calculate_barycenter, calculate_enstrophy, calculate_flow_rate, calculate_geometric_melt_volume, calculate_heat_flux, calculate_kinetic_energy, calculate_mass_conservation, calculate_phase_energy, calculate_phase_statistics, calculate_phase_volumes, calculate_pressure_drop, calculate_pressure_power, calculate_temperature_statistics, calculate_tracer_flow_rate, calculate_tracer_statistics, calculate_viscous_dissipation, calculation_frequency, Parameters::deprecated_fluid_indicator_names(), Parameters::deprecated_verbosity_names(), enstrophy_output_name, flow_rate_output_name, geometric_melt_volume_output_name, heat_flux_output_name, initial_time_for_average_temp_and_hf, initial_time_for_average_velocities, inlet_boundary_id, isocontour_bounding_boxes, kinetic_energy_output_name, mass_conservation_output_name, melting_temperature, monitored_fluid_with_phase_change, outlet_boundary_id, output_frequency, output_q_criterion, output_velocity_gradient, output_vorticity, phase_energy_output_name, phase_output_name, phase_volumes_output_name, postprocessed_fluid, pressure_drop_output_name, pressure_power_output_name, probing_points, string_to_enum(), temperature_output_name, tracer_flow_rate_output_name, tracer_output_name, verbosity, and viscous_dissipation_output_name.

Member Data Documentation

◆ algebraic_melt_volume_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::algebraic_melt_volume_output_name = "melt_volume_alge"

Prefix for the algebraic melt volume output.

Definition at line 1543 of file parameters.h.

◆ apparent_viscosity_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::apparent_viscosity_output_name = "apparent_viscosity"

Prefix for the apparent viscosity output.

Definition at line 1525 of file parameters.h.

◆ barycenter_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::barycenter_output_name = "barycenter_information"

Prefix for the CLS and Cahn-Hilliard barycenter output.

Definition at line 1573 of file parameters.h.

◆ calculate_algebraic_melt_volume

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_algebraic_melt_volume = false

Enable calculation of algebraic melt volume in phase change problems.

Definition at line 1540 of file parameters.h.

◆ calculate_apparent_viscosity

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_apparent_viscosity = false

Enable calculating apparent viscosity.

Definition at line 1467 of file parameters.h.

◆ calculate_average_temp_and_hf

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_average_temp_and_hf = false

Enable average temperature and average heat flux post-processing.

Definition at line 1473 of file parameters.h.

◆ calculate_average_velocities

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_average_velocities = false

Enable velocity post-processing.

Definition at line 1470 of file parameters.h.

◆ calculate_barycenter

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_barycenter = false

Enable barycenter calculation for fluid 1 in CLS and Cahn-Hilliard simulations

Definition at line 1570 of file parameters.h.

◆ calculate_enstrophy

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_enstrophy = false

Enable total enstrophy post-processing.

Definition at line 1458 of file parameters.h.

◆ calculate_flow_rate

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_flow_rate = false

Enable flow rate post-processing.

Definition at line 1485 of file parameters.h.

◆ calculate_geometric_melt_volume

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_geometric_melt_volume = false

Enable calculation of geometric melt volume in phase change problems.

Definition at line 1546 of file parameters.h.

◆ calculate_heat_flux

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_heat_flux = false

Enable heat flux calculation.

Definition at line 1559 of file parameters.h.

◆ calculate_kinetic_energy

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_kinetic_energy = false

Enable total kinetic energy post-processing.

Definition at line 1455 of file parameters.h.

◆ calculate_mass_conservation

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_mass_conservation = true

Enable mass conservation calculation for both fluids in CLS simulations.

Definition at line 1582 of file parameters.h.

◆ calculate_phase_energy

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_phase_energy = false

Enable energies calculation on the domain in Cahn-Hilliard simulations.

Definition at line 1588 of file parameters.h.

◆ calculate_phase_statistics

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_phase_statistics = false

Enable phase statistics.

Definition at line 1576 of file parameters.h.

◆ calculate_phase_volumes

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_phase_volumes = false

Enable calculation of total fluid volume and total particles volume in cfd-dem simulation

Definition at line 1595 of file parameters.h.

◆ calculate_pressure_drop

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_pressure_drop = false

Enable pressure drop post-processing.

Definition at line 1476 of file parameters.h.

◆ calculate_pressure_power

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_pressure_power = false

Enable pressure power post-processing.

Definition at line 1461 of file parameters.h.

◆ calculate_temperature_statistics

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_temperature_statistics = false

Enable temperature statistics.

Definition at line 1534 of file parameters.h.

◆ calculate_tracer_flow_rate

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_tracer_flow_rate = false

Enable tracer flow rate post-processing.

Definition at line 1488 of file parameters.h.

◆ calculate_tracer_statistics

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_tracer_statistics = false

Enable tracer statistics.

Definition at line 1528 of file parameters.h.

◆ calculate_viscous_dissipation

template<int dim>
bool Parameters::PostProcessing< dim >::calculate_viscous_dissipation = false

Enable viscous dissipation post-processing.

Definition at line 1464 of file parameters.h.

◆ calculation_frequency

template<int dim>
unsigned int Parameters::PostProcessing< dim >::calculation_frequency = 1

Frequency of the calculation of post-processed quantities.

Definition at line 1498 of file parameters.h.

◆ enstrophy_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::enstrophy_output_name = "enstrophy"

Prefix for the enstrophy output.

Definition at line 1516 of file parameters.h.

◆ flow_rate_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::flow_rate_output_name = "flow_rate"

Prefix for flow rate output.

Definition at line 1510 of file parameters.h.

◆ geometric_melt_volume_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::geometric_melt_volume_output_name = "melt_volume_geo"

Prefix for the geometric melt volume output.

Definition at line 1549 of file parameters.h.

◆ heat_flux_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::heat_flux_output_name = "heat_flux"

Prefix for the total heat flux output.

Definition at line 1562 of file parameters.h.

◆ initial_time_for_average_temp_and_hf

template<int dim>
double Parameters::PostProcessing< dim >::initial_time_for_average_temp_and_hf = 0.0

Set initial time to start calculations for average temperature and average heat flux

Definition at line 1495 of file parameters.h.

◆ initial_time_for_average_velocities

template<int dim>
double Parameters::PostProcessing< dim >::initial_time_for_average_velocities = 0.0

Set initial time to start calculations for velocities.

Definition at line 1491 of file parameters.h.

◆ inlet_boundary_id

template<int dim>
unsigned int Parameters::PostProcessing< dim >::inlet_boundary_id = 0

The inlet boundary ID for pressure drop calculation.

Definition at line 1479 of file parameters.h.

◆ isocontour_bounding_boxes

template<int dim>
IsocontourBoundingBoxes Parameters::PostProcessing< dim >::isocontour_bounding_boxes

Contains all isocontour bounding boxes.

Definition at line 1446 of file parameters.h.

◆ kinetic_energy_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::kinetic_energy_output_name = "kinetic_energy"

Prefix for kinetic energy output.

Definition at line 1504 of file parameters.h.

◆ mass_conservation_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::mass_conservation_output_name = "mass_conservation_information"

Prefix for the CLS mass conservation output.

Definition at line 1585 of file parameters.h.

◆ melting_temperature

template<int dim>
double Parameters::PostProcessing< dim >::melting_temperature = 0.

Melting temperature iso-value.

Definition at line 1556 of file parameters.h.

◆ monitored_fluid_with_phase_change

template<int dim>
Parameters::FluidIndicator Parameters::PostProcessing< dim >::monitored_fluid_with_phase_change
Initial value:

FluidIndicator corresponding to the fluid which has phase change.

Definition at line 1552 of file parameters.h.

◆ outlet_boundary_id

template<int dim>
unsigned int Parameters::PostProcessing< dim >::outlet_boundary_id = 1

The outlet boundary ID for pressure drop calculation.

Definition at line 1482 of file parameters.h.

◆ output_frequency

template<int dim>
unsigned int Parameters::PostProcessing< dim >::output_frequency = 1

Frequency of the output.

Definition at line 1501 of file parameters.h.

◆ output_q_criterion

template<int dim>
bool Parameters::PostProcessing< dim >::output_q_criterion = true

Enable output of Q-criterion field.

Definition at line 1601 of file parameters.h.

◆ output_velocity_gradient

template<int dim>
bool Parameters::PostProcessing< dim >::output_velocity_gradient = true

Enable output of velocity gradient field.

Definition at line 1607 of file parameters.h.

◆ output_vorticity

template<int dim>
bool Parameters::PostProcessing< dim >::output_vorticity = true

Enable output of vorticity field.

Definition at line 1604 of file parameters.h.

◆ phase_energy_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::phase_energy_output_name = "phase_energy"

Prefix for the energy output in Cahn-Hilliard simulations.

Definition at line 1591 of file parameters.h.

◆ phase_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::phase_output_name = "phase_statistics"

Prefix for the phase output.

Definition at line 1579 of file parameters.h.

◆ phase_volumes_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::phase_volumes_output_name = "phase_volumes"

prefix for the total volume output in cfd-dem simulation

Definition at line 1598 of file parameters.h.

◆ postprocessed_fluid

template<int dim>
Parameters::FluidIndicator Parameters::PostProcessing< dim >::postprocessed_fluid
Initial value:

Fluid domain, used when post-processing a multiphase simulation.

Definition at line 1565 of file parameters.h.

◆ pressure_drop_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::pressure_drop_output_name = "pressure_drop"

Prefix for pressure drop output.

Definition at line 1507 of file parameters.h.

◆ pressure_power_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::pressure_power_output_name = "pressure_power"

Prefix for the pressure power output.

Definition at line 1519 of file parameters.h.

◆ probing_points

template<int dim>
ProbingPoints Parameters::PostProcessing< dim >::probing_points

Contains all probing points.

Definition at line 1449 of file parameters.h.

◆ temperature_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::temperature_output_name = "temperature_statistics"

Prefix for the temperature output.

Definition at line 1537 of file parameters.h.

◆ tracer_flow_rate_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::tracer_flow_rate_output_name = "tracer_flow_rate"

Prefix for tracer flow rate output.

Definition at line 1513 of file parameters.h.

◆ tracer_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::tracer_output_name = "tracer_statistics"

Prefix for the tracer output.

Definition at line 1531 of file parameters.h.

◆ verbosity

template<int dim>
Verbosity Parameters::PostProcessing< dim >::verbosity = Verbosity::quiet

Verbosity level of the post-processed quantities.

Definition at line 1452 of file parameters.h.

◆ viscous_dissipation_output_name

template<int dim>
std::string Parameters::PostProcessing< dim >::viscous_dissipation_output_name = "viscous_dissipation"

Prefix for the viscous dissipation output.

Definition at line 1522 of file parameters.h.


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