SPH
Classes | Enumerations
Settings.h File Reference
#include "common/ForwardDecl.h"
#include "gui/objects/Color.h"
#include "gui/objects/Point.h"
#include "objects/geometry/Vector.h"
#include "objects/utility/EnumMap.h"
#include "objects/wrappers/ExtendedEnum.h"
#include "objects/wrappers/Function.h"
#include "system/Settings.h"

Go to the source code of this file.

Classes

class  GuiSettings
 

Enumerations

enum class  RendererEnum {
  NONE , PARTICLE , MESH , RAYMARCHER ,
  VOLUME , CONTOUR
}
 
enum class  CameraEnum { ORTHO , PERSPECTIVE , FISHEYE , SPHERICAL }
 
enum class  PlotEnum {
  INTERNAL_ENERGY = 1 << 0 , KINETIC_ENERGY = 1 << 1 , TOTAL_ENERGY = 1 << 2 , TOTAL_MOMENTUM = 1 << 3 ,
  TOTAL_ANGULAR_MOMENTUM = 1 << 4 , RELATIVE_ENERGY_CHANGE = 1 << 5 , CURRENT_SFD = 1 << 6 , PREDICTED_SFD = 1 << 7 ,
  SPEED_HISTOGRAM = 1 << 8 , ANGULAR_HISTOGRAM_OF_VELOCITIES = 1 << 9 , SELECTED_PARTICLE = 1 << 10 , ALL = INTERNAL_ENERGY | KINETIC_ENERGY | TOTAL_ENERGY | TOTAL_MOMENTUM | TOTAL_ANGULAR_MOMENTUM
}
 
enum class  BrdfEnum { LAMBERT , PHONG }
 
enum class  ColorMapEnum { LINEAR , LOGARITHMIC , FILMIC }
 
enum class  GuiSettingsId {
  RENDERER , CAMERA_TYPE , CAMERA_POSITION , CAMERA_VELOCITY ,
  CAMERA_ORBIT , CAMERA_TARGET , CAMERA_UP , CAMERA_ORTHO_FOV ,
  CAMERA_PERSPECTIVE_FOV , CAMERA_CLIP_NEAR , CAMERA_CLIP_FAR , CAMERA_AUTOSETUP ,
  CAMERA_TRACK_PARTICLE , CAMERA_TRACK_MEDIAN , CAMERA_TRACKING_OFFSET , VIEW_WIDTH ,
  VIEW_HEIGHT , VIEW_MAX_FRAMERATE , REFRESH_ON_TIMESTEP , VIEW_GRID_SIZE ,
  BACKGROUND_COLOR , COLORMAP_TYPE , COLORMAP_LOGARITHMIC_FACTOR , SHOW_KEY ,
  FORCE_GRAYSCALE , ANTIALIASED , SMOOTH_PARTICLES , RENDER_GHOST_PARTICLES ,
  PARTICLE_RADIUS , CAMERA_ORTHO_CUTOFF , SURFACE_RESOLUTION , SURFACE_LEVEL ,
  SURFACE_SUN_POSITION , SURFACE_SUN_INTENSITY , SURFACE_EMISSION , SURFACE_AMBIENT ,
  RAYTRACE_SUBSAMPLING , RAYTRACE_ITERATION_LIMIT , RAYTRACE_HDRI , RAYTRACE_BRDF ,
  RAYTRACE_SHADOWS , RAYTRACE_SPHERES , VOLUME_EMISSION , VOLUME_ABSORPTION ,
  CONTOUR_SPACING , CONTOUR_GRID_SIZE , CONTOUR_SHOW_LABELS , DEFAULT_COLORIZER ,
  WINDOW_TITLE , WINDOW_WIDTH , WINDOW_HEIGHT , PLOT_INTEGRALS ,
  PLOT_INITIAL_PERIOD , PLOT_OVERPLOT_SFD , IMAGES_RENDERER , IMAGES_WIDTH ,
  IMAGES_HEIGHT , IMAGES_SAVE , IMAGES_PATH , IMAGES_NAME ,
  IMAGES_FIRST_INDEX , IMAGES_MAKE_MOVIE , IMAGES_MOVIE_NAME , IMAGES_TIMESTEP
}
 

Enumeration Type Documentation

◆ BrdfEnum

enum BrdfEnum
strong
Enumerator
LAMBERT 
PHONG 

Definition at line 80 of file Settings.h.

◆ CameraEnum

enum CameraEnum
strong
Enumerator
ORTHO 
PERSPECTIVE 
FISHEYE 
SPHERICAL 

Definition at line 35 of file Settings.h.

◆ ColorMapEnum

enum ColorMapEnum
strong
Enumerator
LINEAR 
LOGARITHMIC 
FILMIC 

Definition at line 85 of file Settings.h.

◆ GuiSettingsId

enum GuiSettingsId
strong
Enumerator
RENDERER 

Selected renderer.

CAMERA_TYPE 
CAMERA_POSITION 
CAMERA_VELOCITY 
CAMERA_ORBIT 
CAMERA_TARGET 
CAMERA_UP 
CAMERA_ORTHO_FOV 

View field of view (zoom). Special value 0 means the field of view is computed from the bounding box.

CAMERA_PERSPECTIVE_FOV 
CAMERA_CLIP_NEAR 
CAMERA_CLIP_FAR 
CAMERA_AUTOSETUP 
CAMERA_TRACK_PARTICLE 
CAMERA_TRACK_MEDIAN 
CAMERA_TRACKING_OFFSET 
VIEW_WIDTH 
VIEW_HEIGHT 
VIEW_MAX_FRAMERATE 
REFRESH_ON_TIMESTEP 
VIEW_GRID_SIZE 

Size of the grid cell in simulation units (not window units); if zero, no grid is drawn.

BACKGROUND_COLOR 
COLORMAP_TYPE 
COLORMAP_LOGARITHMIC_FACTOR 
SHOW_KEY 
FORCE_GRAYSCALE 
ANTIALIASED 
SMOOTH_PARTICLES 
RENDER_GHOST_PARTICLES 
PARTICLE_RADIUS 

Displayed radius of particle in units of smoothing length.

CAMERA_ORTHO_CUTOFF 

Max z-coordinate of particle to be displayed by ortho renderer.

SURFACE_RESOLUTION 

Size of the grid used in MarchingCubes (in code units, not h).

SURFACE_LEVEL 

Value of iso-surface being constructed; lower value means larget bodies.

SURFACE_SUN_POSITION 

Direction to the sun used for shading.

SURFACE_SUN_INTENSITY 

Intentity of the sun.

SURFACE_EMISSION 
SURFACE_AMBIENT 

Ambient color for surface renderer.

RAYTRACE_SUBSAMPLING 
RAYTRACE_ITERATION_LIMIT 
RAYTRACE_HDRI 
RAYTRACE_BRDF 
RAYTRACE_SHADOWS 
RAYTRACE_SPHERES 
VOLUME_EMISSION 
VOLUME_ABSORPTION 
CONTOUR_SPACING 
CONTOUR_GRID_SIZE 
CONTOUR_SHOW_LABELS 
DEFAULT_COLORIZER 
WINDOW_TITLE 

Title of the window appearing on taskbar.

WINDOW_WIDTH 
WINDOW_HEIGHT 
PLOT_INTEGRALS 
PLOT_INITIAL_PERIOD 
PLOT_OVERPLOT_SFD 
IMAGES_RENDERER 
IMAGES_WIDTH 
IMAGES_HEIGHT 
IMAGES_SAVE 

If true, rendered images are saved to disk.

IMAGES_PATH 

Path of directory where the rendered images will be saved.

IMAGES_NAME 

Mask of the image names, having d where the output number will be placed.

IMAGES_FIRST_INDEX 
IMAGES_MAKE_MOVIE 
IMAGES_MOVIE_NAME 
IMAGES_TIMESTEP 

Time interval (in run time) of image saving. Note that images do not have to be saved exactly in specified times, as time step of the run is generally different than this value.

Definition at line 91 of file Settings.h.

◆ PlotEnum

enum PlotEnum
strong
Enumerator
INTERNAL_ENERGY 

Evolution of the total internal energy in time.

KINETIC_ENERGY 

Evolution of the total kinetic energy in time.

TOTAL_ENERGY 

Evolution of the total energy (sum of total kinetic energy and total internal energy) in time

Todo:
Currently does not contain potential energy!
TOTAL_MOMENTUM 

Evolution of the total momentum in time.

TOTAL_ANGULAR_MOMENTUM 

Evolution of the total angular momentum in time.

RELATIVE_ENERGY_CHANGE 

Relative change of total energy.

CURRENT_SFD 

Current size-frequency distribution.

PREDICTED_SFD 

Predicted size-frequency distribution.

SPEED_HISTOGRAM 

Speed histogram.

ANGULAR_HISTOGRAM_OF_VELOCITIES 

Angular histogram (in x-y plane) of velocity directions.

SELECTED_PARTICLE 

Evolution of the selected quantity for the selected particle in time.

ALL 

Definition at line 42 of file Settings.h.

◆ RendererEnum

enum RendererEnum
strong
Enumerator
NONE 

No particle visualization.

PARTICLE 

2D section showing particles as points

MESH 

Surfaces of bodies are meshed using Marching cubes and drawed as triangles.

RAYMARCHER 

Raymarcher that computes intersections with implicit surface.

VOLUME 

Volumetric renderer.

CONTOUR 

Draws contours (iso-lines) of quantities.

Definition at line 14 of file Settings.h.