Struct for settings of calculation. More...

#include <settings.hpp>

Collaboration diagram for Settings:

Public Attributes
int	dim {}
	Dimension of the simulation.

double	particleDistance {}
	Initial distance between particles.

double	dt {}
	Time step.

double	endTime {}
	End time of the simulation.

double	outputPeriod {}
	Output period of the simulation.

double	cflCondition {}
	CFL condition.

int	numPhysicalCores {}
	Number of cores to calculate.

Domain	domain {}
	domain of the simulation

double	kinematicViscosity {}
	Kinematic viscosity.

double	defaultDensity {}
	default density for fluid and wall particles.

Eigen::Vector3d	gravity
	Gravity.

double	surfaceDetection_numberDensity_threshold {}
	threshold ratio of number density for free surface detection

bool	surfaceDetection_particleDistribution {}
	flag for free surface detection based on particle distribution

double	surfaceDetection_particleDistribution_threshold {}

std::string	pressureCalculationMethod {}
	Method for pressure calculation.

double	compressibility {}
	Compressibility of the fluid for Implicit method.

double	relaxationCoefficientForPressure {}
	Relaxation coefficient for pressure for Implicit method.

double	soundSpeed {}
	Speed of sound for Explicit method.

double	collisionDistance {}
	Distance for collision detection.

double	coefficientOfRestitution {}
	Coefficient of restitution.

double	re_forNumberDensity {}
	Effective radius for number density.

double	re_forGradient {}
	Effective radius for gradient.

double	re_forLaplacian {}
	Effective radius for Laplacian.

double	reMax {}
	Maximum of effective radius.

std::filesystem::path	particlesPath
	Path for input particle file.

bool	outputVtkInBinary {}
	Flag for saving VTK file in binary format.

Detailed Description

Struct for settings of calculation.

This struct contains the settings for the simulation. It is used to load the settings from the input file.

Definition at line 15 of file settings.hpp.

Member Data Documentation

◆ dim

int Settings::dim {}

Dimension of the simulation.

Definition at line 17 of file settings.hpp.

17{};

◆ particleDistance

double Settings::particleDistance {}

Initial distance between particles.

Definition at line 18 of file settings.hpp.

18{};

◆ dt

double Settings::dt {}

Time step.

Definition at line 19 of file settings.hpp.

19{};

◆ endTime

double Settings::endTime {}

End time of the simulation.

Definition at line 20 of file settings.hpp.

20{};

◆ outputPeriod

double Settings::outputPeriod {}

Output period of the simulation.

Definition at line 21 of file settings.hpp.

21{};

◆ cflCondition

double Settings::cflCondition {}

CFL condition.

Definition at line 22 of file settings.hpp.

22{};

◆ numPhysicalCores

int Settings::numPhysicalCores {}

Number of cores to calculate.

Definition at line 23 of file settings.hpp.

23{};

◆ domain

Domain Settings::domain {}

domain of the simulation

Definition at line 25 of file settings.hpp.

25{};

◆ kinematicViscosity

double Settings::kinematicViscosity {}

Kinematic viscosity.

Definition at line 28 of file settings.hpp.

28{};

◆ defaultDensity

double Settings::defaultDensity {}

default density for fluid and wall particles.

Definition at line 29 of file settings.hpp.

29{};

◆ gravity

Eigen::Vector3d Settings::gravity

Gravity.

Definition at line 32 of file settings.hpp.

◆ surfaceDetection_numberDensity_threshold

double Settings::surfaceDetection_numberDensity_threshold {}

threshold ratio of number density for free surface detection

Definition at line 36 of file settings.hpp.

36{};

◆ surfaceDetection_particleDistribution

bool Settings::surfaceDetection_particleDistribution {}

flag for free surface detection based on particle distribution

Definition at line 38 of file settings.hpp.

38{};

◆ surfaceDetection_particleDistribution_threshold

double Settings::surfaceDetection_particleDistribution_threshold {}

Definition at line 39 of file settings.hpp.

39{};

◆ pressureCalculationMethod

std::string Settings::pressureCalculationMethod {}

Method for pressure calculation.

Definition at line 42 of file settings.hpp.

42{};

◆ compressibility

double Settings::compressibility {}

Compressibility of the fluid for Implicit method.

Definition at line 44 of file settings.hpp.

44{};

◆ relaxationCoefficientForPressure

double Settings::relaxationCoefficientForPressure {}

Relaxation coefficient for pressure for Implicit method.

Definition at line 45 of file settings.hpp.

45{};

◆ soundSpeed

double Settings::soundSpeed {}

Speed of sound for Explicit method.

Definition at line 47 of file settings.hpp.

47{};

◆ collisionDistance

double Settings::collisionDistance {}

Distance for collision detection.

Definition at line 50 of file settings.hpp.

50{};

◆ coefficientOfRestitution

double Settings::coefficientOfRestitution {}

Coefficient of restitution.

Definition at line 51 of file settings.hpp.

51{};

◆ re_forNumberDensity

double Settings::re_forNumberDensity {}

Effective radius for number density.

Definition at line 54 of file settings.hpp.

54{};

◆ re_forGradient

double Settings::re_forGradient {}

Effective radius for gradient.

Definition at line 55 of file settings.hpp.

55{};

◆ re_forLaplacian

double Settings::re_forLaplacian {}

Effective radius for Laplacian.

Definition at line 56 of file settings.hpp.

56{};

◆ reMax

double Settings::reMax {}

Maximum of effective radius.

Definition at line 57 of file settings.hpp.

57{};

◆ particlesPath

std::filesystem::path Settings::particlesPath

Path for input particle file.

Definition at line 60 of file settings.hpp.

◆ outputVtkInBinary

bool Settings::outputVtkInBinary {}

Flag for saving VTK file in binary format.

Definition at line 61 of file settings.hpp.

61{};

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

src/settings.hpp

Public Attributes