Parameters related to the flow solver. More...

#include <parameters_flow_solver.h>

Collaboration diagram for PHiLiP::Parameters::FlowSolverParam:

Public Types
enum	FlowCaseType { taylor_green_vortex, decaying_homogeneous_isotropic_turbulence, burgers_viscous_snapshot, naca0012, burgers_rewienski_snapshot, burgers_inviscid, convection_diffusion, advection, periodic_1D_unsteady, gaussian_bump, isentropic_vortex, kelvin_helmholtz_instability, non_periodic_cube_flow, sod_shock_tube, low_density_2d, leblanc_shock_tube, shu_osher_problem, advection_limiter, burgers_limiter }
	Selects the flow case to be simulated.

enum	DensityInitialConditionType { uniform, isothermal }
	For taylor green vortex, selects the type of density initialization.

enum	ApplyInitialConditionMethod { interpolate_initial_condition_function, project_initial_condition_function, read_values_from_file_and_project }
	Selects the method for applying the initial condition.

Public Member Functions
void	parse_parameters (dealii::ParameterHandler &prm)
	Parses input file and sets the variables.

Static Public Member Functions
static void	declare_parameters (dealii::ParameterHandler &prm)
	Declares the possible variables and sets the defaults.

Public Attributes
FlowCaseType	flow_case_type
	Selected FlowCaseType from the input file.

unsigned int	poly_degree
	Polynomial order (P) of the basis functions for DG.

unsigned int	max_poly_degree_for_adaptation
	Maximum polynomial order of the DG basis functions for adaptation.

double	final_time
	Final solution time.

double	constant_time_step
	Constant time step.

double	courant_friedrichs_lewy_number
	Courant-Friedrich-Lewy (CFL) number for constant time step.

std::string	unsteady_data_table_filename

bool	steady_state
	Flag for solving steady state solution.

bool	steady_state_polynomial_ramping
	Flag for steady state polynomial ramping.

bool	error_adaptive_time_step
	Computes time step based on error.

bool	adaptive_time_step
	Flag for computing the time step on the fly.

std::string	sensitivity_table_filename

std::string	input_mesh_filename

bool	use_gmsh_mesh
	< Flag for using input mesh file

bool	mesh_reader_verbose_output
	< Flag for verbose (true) or quiet (false) mesh reader output

bool	use_periodic_BC_in_x
	Flag for using periodic boundary conditions in the x-direction. More...

bool	use_periodic_BC_in_y
	Flag for using periodic boundary conditions in the y-direction.

bool	use_periodic_BC_in_z
	Flag for using periodic boundary conditions in the z-direction.

int	x_periodic_id_face_1
	Custom Boundary IDs for the first periodic face in the x-direction. More...

int	x_periodic_id_face_2
	Custom Boundary IDs for the second periodic face in the x-direction.

int	y_periodic_id_face_1
	Custom Boundary IDs for the first periodic face in the y-direction. More...

int	y_periodic_id_face_2
	Custom Boundary IDs for the second periodic face in the y-direction.

int	z_periodic_id_face_1
	Custom Boundary IDs for the first periodic face in the z-direction. More...

int	z_periodic_id_face_2
	Custom Boundary IDs for the first periodic face in the z-direction.

bool	restart_computation_from_file
	Restart computation from restart file.

bool	output_restart_files
	Output the restart files.

std::string	restart_files_directory_name
	Name of directory for writing and reading restart files.

unsigned int	restart_file_index
	Index of desired restart file for restarting the computation from.

int	output_restart_files_every_x_steps
	Outputs the restart files every x steps.

double	output_restart_files_every_dt_time_intervals
	Outputs the restart files at time intervals of dt.

unsigned int	grid_degree
	Parameters related to mesh generation. More...

double	grid_left_bound
	Left bound of domain for hyper_cube mesh based cases.

double	grid_right_bound
	Right bound of domain for hyper_cube mesh based cases.

unsigned int	number_of_grid_elements_per_dimension
	Number of grid elements per dimension for hyper_cube mesh based cases.

int	number_of_mesh_refinements
	Number of refinements for naca0012 and Gaussian bump based cases.

double	channel_height
	Height of channel for gaussian bump case.

double	channel_length
	Width of channel for gaussian bump case.

double	bump_height
	Height of gaussian bump.

int	number_of_subdivisions_in_x_direction
	Number of subdivisions in x direction for gaussian bump case.

int	number_of_subdivisions_in_y_direction
	Number of subdivisions in y direction for gaussian bump case.

int	number_of_subdivisions_in_z_direction
	Number of subdivisions in z direction for gaussian bump case.

double	expected_kinetic_energy_at_final_time

double	expected_theoretical_dissipation_rate_at_final_time

DensityInitialConditionType	density_initial_condition_type
	Selected DensityInitialConditionType from the input file.

bool	do_calculate_numerical_entropy
	For TGV, flag to calculate and write numerical entropy.

double	atwood_number
	For KHI, the atwood number.

ApplyInitialConditionMethod	apply_initial_condition_method
	Selected ApplyInitialConditionMethod from the input file.

std::string	input_flow_setup_filename_prefix

bool	output_velocity_field_at_fixed_times
	Flag for outputting velocity field at fixed times.

std::string	output_velocity_field_times_string
	String of velocity field output times.

unsigned int	number_of_times_to_output_velocity_field
	Number of fixed times to output the velocity field.

bool	output_vorticity_magnitude_field_in_addition_to_velocity
	Flag for outputting vorticity magnitude field in addition to velocity field.

std::string	output_flow_field_files_directory_name
	Name of directory for writing flow field files.

bool	end_exactly_at_final_time
	Flag to adjust the last timestep such that the simulation ends exactly at final_time.

Detailed Description

Parameters related to the flow solver.

Definition at line 12 of file parameters_flow_solver.h.

Member Data Documentation

◆ expected_kinetic_energy_at_final_time

double PHiLiP::Parameters::FlowSolverParam::expected_kinetic_energy_at_final_time

For taylor green vortex integration tests, expected kinetic energy at final time.

Definition at line 110 of file parameters_flow_solver.h.

◆ expected_theoretical_dissipation_rate_at_final_time

double PHiLiP::Parameters::FlowSolverParam::expected_theoretical_dissipation_rate_at_final_time

For taylor green vortex integration tests, expected theoretical kinetic energy dissipation rate at final time.

Definition at line 115 of file parameters_flow_solver.h.

◆ grid_degree

unsigned int PHiLiP::Parameters::FlowSolverParam::grid_degree

Parameters related to mesh generation.

Polynomial degree of the grid

Definition at line 97 of file parameters_flow_solver.h.

◆ input_flow_setup_filename_prefix

std::string PHiLiP::Parameters::FlowSolverParam::input_flow_setup_filename_prefix

Filename prefix of the input flow setup file. Example: 'setup' for files named setup-0000i.dat, where i is the MPI rank. For initializing the flow with values from a file. To be set when apply_initial_condition_method is read_values_from_file_and_project.

Definition at line 142 of file parameters_flow_solver.h.

◆ input_mesh_filename

std::string PHiLiP::Parameters::FlowSolverParam::input_mesh_filename

Name of the Gmsh file to be read if the flow_solver_case reads a mesh file; will read the file: input_mesh_filename.msh

Definition at line 64 of file parameters_flow_solver.h.

◆ sensitivity_table_filename

std::string PHiLiP::Parameters::FlowSolverParam::sensitivity_table_filename

Name of the output file for writing the sensitivity data; will be written to file: sensitivity_table_filename.txt

Definition at line 60 of file parameters_flow_solver.h.

◆ unsteady_data_table_filename

std::string PHiLiP::Parameters::FlowSolverParam::unsteady_data_table_filename

Name of the output file for writing the unsteady data; will be written to file: unsteady_data_table_filename.txt

Definition at line 50 of file parameters_flow_solver.h.

◆ use_periodic_BC_in_x

bool PHiLiP::Parameters::FlowSolverParam::use_periodic_BC_in_x

Flag for using periodic boundary conditions in the x-direction.

Toggle for specifiying periodic boundary conditions on x, y, or z-direction

Definition at line 70 of file parameters_flow_solver.h.

◆ x_periodic_id_face_1

int PHiLiP::Parameters::FlowSolverParam::x_periodic_id_face_1

Custom Boundary IDs for the first periodic face in the x-direction.

Custom periodic boundary condition ID in x-direction

Definition at line 76 of file parameters_flow_solver.h.

◆ y_periodic_id_face_1

int PHiLiP::Parameters::FlowSolverParam::y_periodic_id_face_1

Custom Boundary IDs for the first periodic face in the y-direction.

Custom periodic boundary condition ID in y-direction

Definition at line 81 of file parameters_flow_solver.h.

◆ z_periodic_id_face_1

int PHiLiP::Parameters::FlowSolverParam::z_periodic_id_face_1

Custom Boundary IDs for the first periodic face in the z-direction.

Custom periodic boundary condition ID in z-direction

Definition at line 86 of file parameters_flow_solver.h.

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

src/parameters/parameters_flow_solver.h
src/parameters/parameters_flow_solver.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes