SPH
QuantityIds.cpp
Go to the documentation of this file.
1 #include "quantities/QuantityIds.h"
2 #include "objects/utility/EnumMap.h"
3 
4 NAMESPACE_SPH_BEGIN
5 
6 QuantityMetadata::QuantityMetadata(const std::string& fullName,
7  const std::wstring& label,
8  const ValueEnum type,
9  const std::string& dtName,
10  const std::string& d2tName)
11  : quantityName(fullName)
12  , label(label)
13  , expectedType(type) {
14  if (!dtName.empty()) {
15  derivativeName = dtName;
16  } else {
17  derivativeName = quantityName + " derivative";
18  }
19 
20  if (!d2tName.empty()) {
21  secondDerivativeName = d2tName;
22  } else {
23  secondDerivativeName = quantityName + " 2nd derivative";
24  }
25 }
26 
27 QuantityMetadata getMetadata(const QuantityId key) {
28  switch (key) {
29  case QuantityId::POSITION:
30  return QuantityMetadata("Position", L"r", ValueEnum::VECTOR, "Velocity", "Acceleration");
31  case QuantityId::MASS:
32  return QuantityMetadata("Particle mass", L"m", ValueEnum::SCALAR);
33  case QuantityId::PRESSURE:
34  return QuantityMetadata("Pressure", L"p", ValueEnum::SCALAR);
35  case QuantityId::DENSITY:
36  return QuantityMetadata("Density", L"\u03C1" /*rho*/, ValueEnum::SCALAR);
37  case QuantityId::ENERGY:
38  return QuantityMetadata("Specific energy", L"u", ValueEnum::SCALAR);
39  case QuantityId::TEMPERATURE:
40  return QuantityMetadata("Temperature", L"T", ValueEnum::SCALAR);
41  case QuantityId::SOUND_SPEED:
42  return QuantityMetadata("Sound speed", L"c_s", ValueEnum::SCALAR);
43  case QuantityId::DEVIATORIC_STRESS:
44  return QuantityMetadata("Deviatoric stress", L"S", ValueEnum::TRACELESS_TENSOR);
45  case QuantityId::SPECIFIC_ENTROPY:
46  return QuantityMetadata("Specific entropy", L"s", ValueEnum::SCALAR);
47  case QuantityId::GENERALIZED_ENERGY:
48  return QuantityMetadata("Generalized energy", L"Y", ValueEnum::SCALAR);
49  case QuantityId::GENERALIZED_PRESSURE:
50  return QuantityMetadata("Generalized pressure", L"p^alpha", ValueEnum::SCALAR);
51  case QuantityId::DAMAGE:
52  return QuantityMetadata("Damage", L"D", ValueEnum::SCALAR);
53  case QuantityId::EPS_MIN:
54  return QuantityMetadata("Activation strain", L"\u03B5" /*epsilon*/, ValueEnum::SCALAR);
55  case QuantityId::M_ZERO:
56  return QuantityMetadata("Weibull exponent of stretched distribution", L"m_0", ValueEnum::SCALAR);
57  case QuantityId::EXPLICIT_GROWTH:
58  return QuantityMetadata("Explicit crack growth", L"???", ValueEnum::SCALAR);
59  case QuantityId::N_FLAWS:
60  return QuantityMetadata("Number of flaws", L"N_flaws", ValueEnum::INDEX);
61  case QuantityId::STRESS_REDUCING:
62  return QuantityMetadata("Yielding reduce", L"Red", ValueEnum::SCALAR);
63  case QuantityId::DISTENTION:
64  return QuantityMetadata("Distention", L"\u03B1" /*alpha*/, ValueEnum::SCALAR);
65  case QuantityId::VELOCITY_GRADIENT:
66  return QuantityMetadata("Velocity gradient", L"\u2207v" /*nabla v*/, ValueEnum::SYMMETRIC_TENSOR);
67  case QuantityId::VELOCITY_DIVERGENCE:
68  return QuantityMetadata("Velocity divergence", L"\u2207\u22C5v" /*nabla cdot v*/, ValueEnum::SCALAR);
69  case QuantityId::VELOCITY_ROTATION:
70  return QuantityMetadata("Velocity rotation", L"\u2207\u2A2Fv" /*nabla cross v*/, ValueEnum::VECTOR);
71  case QuantityId::STRAIN_RATE_CORRECTION_TENSOR:
72  return QuantityMetadata("Correction tensor", L"C", ValueEnum::SYMMETRIC_TENSOR);
73  case QuantityId::VELOCITY_LAPLACIAN:
74  return QuantityMetadata("Velocity laplacian", L"\u0394v" /*Delta v*/, ValueEnum::VECTOR);
75  case QuantityId::VELOCITY_GRADIENT_OF_DIVERGENCE:
76  return QuantityMetadata("Gradient of velocity divergence",
77  L"\u2207(\u2207\u22C5v)" /*nabla(nabla cdot v)*/,
78  ValueEnum::VECTOR);
79  case QuantityId::FRICTION:
80  return QuantityMetadata("Friction", L"f", ValueEnum::VECTOR);
81  case QuantityId::VIBRATIONAL_VELOCITY:
82  return QuantityMetadata("Vibrational velocity", L"v_vib", ValueEnum::SCALAR);
83  case QuantityId::BULK_DENSITY:
84  return QuantityMetadata("Bulk density", L"\u03C1_b", ValueEnum::SCALAR);
85  case QuantityId::ENERGY_LAPLACIAN:
86  return QuantityMetadata("Energy laplacian", L"\u0394u" /*Delta u*/, ValueEnum::SCALAR);
87  case QuantityId::AV_ALPHA:
88  return QuantityMetadata("AV alpha", L"\u03B1_AV" /*alpha_AV*/, ValueEnum::SCALAR);
89  case QuantityId::AV_STRESS:
90  return QuantityMetadata("Artificial stress", L"R", ValueEnum::SYMMETRIC_TENSOR);
91  case QuantityId::AV_BALSARA:
92  return QuantityMetadata("Balsara switch", L"f", ValueEnum::SCALAR);
93  case QuantityId::INTERPARTICLE_SPACING_KERNEL:
94  return QuantityMetadata("Interparticle spacing kernel", L"w(\u0394 p)", ValueEnum::SCALAR);
95  case QuantityId::DISPLACEMENT:
96  return QuantityMetadata("Displacement", L"u", ValueEnum::VECTOR);
97  case QuantityId::FLAG:
98  return QuantityMetadata("Flag", L"flag", ValueEnum::INDEX);
99  case QuantityId::MATERIAL_ID:
100  return QuantityMetadata("Material ID", L"matID", ValueEnum::INDEX);
101  case QuantityId::PERSISTENT_INDEX:
102  return QuantityMetadata("Original index", L"flag_0", ValueEnum::INDEX);
103  case QuantityId::XSPH_VELOCITIES:
104  return QuantityMetadata("XSPH correction", L"xsph", ValueEnum::VECTOR);
105  case QuantityId::GRAD_H:
106  return QuantityMetadata("Grad-h terms", L"\u03A9" /*Omega*/, ValueEnum::SCALAR);
107  case QuantityId::AGGREGATE_ID:
108  return QuantityMetadata("Aggregate ID", L"i", ValueEnum::INDEX);
109  case QuantityId::ANGULAR_FREQUENCY:
110  return QuantityMetadata("Angular frequency", L"\u03C9" /*omega*/, ValueEnum::VECTOR);
111  case QuantityId::ANGULAR_MOMENTUM:
112  return QuantityMetadata("Angular momentum", L"L", ValueEnum::VECTOR);
113  case QuantityId::NEIGHBOUR_CNT:
114  return QuantityMetadata("Neigh. cnt", L"N_neigh", ValueEnum::INDEX);
115  case QuantityId::SURFACE_NORMAL:
116  return QuantityMetadata("Surf. normal", L"n", ValueEnum::VECTOR);
117  case QuantityId::MOMENT_OF_INERTIA:
118  return QuantityMetadata("Moment of intertia", L"I", ValueEnum::SCALAR);
119  case QuantityId::PHASE_ANGLE:
120  return QuantityMetadata("Phase angle", L"\u03C6" /*phi*/, ValueEnum::VECTOR);
121  case QuantityId::SMOOTHING_LENGTH:
122  return QuantityMetadata("Smoothing length", L"h", ValueEnum::SCALAR);
123  case QuantityId::DELTASPH_DENSITY_GRADIENT:
124  return QuantityMetadata("Density gradient", L"\u2207\u03C1", ValueEnum::VECTOR);
125  case QuantityId::UVW:
126  return QuantityMetadata("Mapping coordinates", L"uvw", ValueEnum::VECTOR);
127  default:
128  NOT_IMPLEMENTED;
129  }
130 }
131 
132 NAMESPACE_SPH_END
NOT_IMPLEMENTED
#define NOT_IMPLEMENTED
Helper macro marking missing implementation.
Definition: Assert.h:100
NAMESPACE_SPH_BEGIN
NAMESPACE_SPH_BEGIN
Definition: BarnesHut.cpp:13
EnumMap.h
Helper object for converting enums to string, listing all available values of enum,...
NAMESPACE_SPH_END
#define NAMESPACE_SPH_END
Definition: Object.h:12
ValueEnum
ValueEnum
Definition: QuantityHelpers.h:13
ValueEnum::SYMMETRIC_TENSOR
@ SYMMETRIC_TENSOR
ValueEnum::TRACELESS_TENSOR
@ TRACELESS_TENSOR
getMetadata
QuantityMetadata getMetadata(const QuantityId key)
Returns the quantity information using quantity ID.
Definition: QuantityIds.cpp:27
QuantityIds.h
Quantity identifiers.
QuantityId
QuantityId
Unique IDs of basic quantities of SPH particles.
Definition: QuantityIds.h:19
QuantityId::BULK_DENSITY
@ BULK_DENSITY
Bulk density, may be lower than the material density.
QuantityId::AV_ALPHA
@ AV_ALPHA
Coefficient alpha of the artificial viscosity. Coefficient beta is always 2*alpha.
QuantityId::M_ZERO
@ M_ZERO
Coefficient M_0 of the stretched Weibull distribution.
QuantityId::FLAG
@ FLAG
ID of original body, used to implement discontinuities between bodies in SPH.
QuantityId::VELOCITY_DIVERGENCE
@ VELOCITY_DIVERGENCE
Velocity divergence.
QuantityId::STRAIN_RATE_CORRECTION_TENSOR
@ STRAIN_RATE_CORRECTION_TENSOR
Correction tensor used to improve conservation of total angular momentum.
QuantityId::DISPLACEMENT
@ DISPLACEMENT
Displacement vector, a solution of the stress analysis.
QuantityId::EXPLICIT_GROWTH
@ EXPLICIT_GROWTH
Explicit growth of fractures.
QuantityId::DEVIATORIC_STRESS
@ DEVIATORIC_STRESS
Deviatoric stress tensor, always a traceless tensor.
QuantityId::INTERPARTICLE_SPACING_KERNEL
@ INTERPARTICLE_SPACING_KERNEL
Auxiliary quantity needed for evaluating artificial stress.
QuantityId::PRESSURE
@ PRESSURE
Pressure, affected by yielding and fragmentation model, always a scalar quantity.
QuantityId::AV_BALSARA
@ AV_BALSARA
Balsara factor.
QuantityId::MOMENT_OF_INERTIA
@ MOMENT_OF_INERTIA
Moment of inertia of particles, analogy of particle masses for rotation.
QuantityId::VELOCITY_GRADIENT
@ VELOCITY_GRADIENT
Velocity gradient.
QuantityId::DAMAGE
@ DAMAGE
Damage.
QuantityId::ENERGY_LAPLACIAN
@ ENERGY_LAPLACIAN
Laplacian of internal energy, used in heat diffusion equation.
QuantityId::N_FLAWS
@ N_FLAWS
Number of explicit flaws per particle.
QuantityId::POSITION
@ POSITION
Positions (velocities, accelerations) of particles, always a vector quantity,.
QuantityId::ENERGY
@ ENERGY
Specific internal energy, always a scalar quantity.
QuantityId::VELOCITY_LAPLACIAN
@ VELOCITY_LAPLACIAN
QuantityId::AGGREGATE_ID
@ AGGREGATE_ID
Index of the aggregate containing this particle.
QuantityId::VELOCITY_ROTATION
@ VELOCITY_ROTATION
Velocity rotation.
QuantityId::GENERALIZED_PRESSURE
@ GENERALIZED_PRESSURE
QuantityId::DENSITY
@ DENSITY
Density, always a scalar quantity.
QuantityId::TEMPERATURE
@ TEMPERATURE
Temperature, always a scalar quantity.
QuantityId::DELTASPH_DENSITY_GRADIENT
@ DELTASPH_DENSITY_GRADIENT
QuantityId::SURFACE_NORMAL
@ SURFACE_NORMAL
Vector approximating surface normal.
QuantityId::MASS
@ MASS
Paricles masses, always a scalar quantity.
QuantityId::NEIGHBOUR_CNT
@ NEIGHBOUR_CNT
Number of neighbouring particles (in radius h * kernel.radius)
QuantityId::SPECIFIC_ENTROPY
@ SPECIFIC_ENTROPY
Specific entropy, always a scalar quantity.
QuantityId::SOUND_SPEED
@ SOUND_SPEED
Sound speed, always a scalar quantity.
QuantityId::DISTENTION
@ DISTENTION
Ratio of the solid and bulk density (parameter alpha in P-alpha and eps-alpha models).
QuantityId::GENERALIZED_ENERGY
@ GENERALIZED_ENERGY
The "Y" quantity defined by , used to compute equation of motion and energy in DISPH.
QuantityId::AV_STRESS
@ AV_STRESS
Artificial stress by Monaghan .
QuantityId::STRESS_REDUCING
@ STRESS_REDUCING
Total stress reduction factor due to damage and yielding. Is always scalar.
QuantityId::VIBRATIONAL_VELOCITY
@ VIBRATIONAL_VELOCITY
Vibrational particle velocity, used by the block model of acoustic fluidization.
QuantityId::MATERIAL_ID
@ MATERIAL_ID
Index of material of the particle. Can be generally different than the flag value.
QuantityId::EPS_MIN
@ EPS_MIN
Activation strait rate.
QuantityId::UVW
@ UVW
Texture mapping coordinates,.
QuantityId::VELOCITY_GRADIENT_OF_DIVERGENCE
@ VELOCITY_GRADIENT_OF_DIVERGENCE
QuantityMetadata
Auxiliary information about quantity that aren't stored directly in Quantity.
Definition: QuantityIds.h:239
QuantityMetadata::derivativeName
std::string derivativeName
Name of the 1st derivative.
Definition: QuantityIds.h:248
QuantityMetadata::quantityName
std::string quantityName
Full name of the quantity (i.e. 'Density', 'Deviatoric stress', ...)
Definition: QuantityIds.h:242
QuantityMetadata::secondDerivativeName
std::string secondDerivativeName
Name of the second derivative.
Definition: QuantityIds.h:253
QuantityMetadata::QuantityMetadata
QuantityMetadata(const std::string &fullName, const std::wstring &label, const ValueEnum type, const std::string &derivativeName="", const std::string &secondDerivativeName="")
Definition: QuantityIds.cpp:6
Generated by doxygen 1.9.1