mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
STYLE: Updated Doxygen comment markers
This commit is contained in:
@ -117,8 +117,8 @@ public:
|
||||
//- Operation mode enumeration
|
||||
enum operationMode
|
||||
{
|
||||
fixedHeatFlux, //< Fixed heat flux
|
||||
fixedHeatTransferCoeff, //< Fixed heat transfer coefficient
|
||||
fixedHeatFlux, //!< Fixed heat flux
|
||||
fixedHeatTransferCoeff, //!< Fixed heat transfer coefficient
|
||||
unknown
|
||||
};
|
||||
|
||||
|
||||
@ -106,8 +106,8 @@ public:
|
||||
//- Region type enumeration
|
||||
enum regionTypes
|
||||
{
|
||||
vrtCellZone, //< cell zone
|
||||
vrtAll //< all cells
|
||||
vrtCellZone, //!< cell zone
|
||||
vrtAll //!< all cells
|
||||
};
|
||||
|
||||
//- Region type names
|
||||
|
||||
@ -107,11 +107,11 @@ public:
|
||||
//- Operation type enumeration
|
||||
enum operationType
|
||||
{
|
||||
opAdd, //< Add
|
||||
opSubtract, //< Subtract
|
||||
opMin, //< Minimum
|
||||
opMax, //< Maximum
|
||||
opAverage //< Average
|
||||
opAdd, //!< Add
|
||||
opSubtract, //!< Subtract
|
||||
opMin, //!< Minimum
|
||||
opMax, //!< Maximum
|
||||
opAverage //!< Average
|
||||
};
|
||||
|
||||
//- Operation type names
|
||||
|
||||
@ -199,21 +199,21 @@ public:
|
||||
//- Operation type enumeration
|
||||
enum operationType
|
||||
{
|
||||
opNone, //< None
|
||||
opSum, //< Sum
|
||||
opSumMag, //< Magnitude of sum
|
||||
opSumDirection, //< Sum in a given direction
|
||||
opSumDirectionBalance, //< Sum in a given direction for multiple
|
||||
opAverage, //< Average
|
||||
opWeightedAverage, //< Weighted average
|
||||
opAreaAverage, //< Area average
|
||||
opWeightedAreaAverage, //< Weighted area average
|
||||
opAreaIntegrate, //< Area integral
|
||||
opMin, //< Minimum
|
||||
opMax, //< Maximum
|
||||
opCoV, //< Coefficient of variation
|
||||
opAreaNormalAverage, //< Area average in normal direction
|
||||
opAreaNormalIntegrate //< Area integral in normal direction
|
||||
opNone, //!< None
|
||||
opSum, //!< Sum
|
||||
opSumMag, //!< Magnitude of sum
|
||||
opSumDirection, //!< Sum in a given direction
|
||||
opSumDirectionBalance, //!< Sum in a given direction for multiple
|
||||
opAverage, //!< Average
|
||||
opWeightedAverage, //!< Weighted average
|
||||
opAreaAverage, //!< Area average
|
||||
opWeightedAreaAverage, //!< Weighted area average
|
||||
opAreaIntegrate, //!< Area integral
|
||||
opMin, //!< Minimum
|
||||
opMax, //!< Maximum
|
||||
opCoV, //!< Coefficient of variation
|
||||
opAreaNormalAverage, //!< Area average in normal direction
|
||||
opAreaNormalIntegrate //!< Area integral in normal direction
|
||||
};
|
||||
|
||||
//- Operation type names
|
||||
|
||||
@ -110,9 +110,9 @@ public:
|
||||
//- Face mode type
|
||||
enum modeType
|
||||
{
|
||||
mdFaceZone, //< face zone
|
||||
mdFaceZoneAndDirection, //< face zone with prescribed direction
|
||||
mdCellZoneAndDirection //< cell zone with prescribed direction
|
||||
mdFaceZone, //!< face zone
|
||||
mdFaceZoneAndDirection, //!< face zone with prescribed direction
|
||||
mdCellZoneAndDirection //!< cell zone with prescribed direction
|
||||
};
|
||||
|
||||
//- Mode type names
|
||||
|
||||
@ -69,9 +69,9 @@ public:
|
||||
|
||||
enum renderModeType
|
||||
{
|
||||
rmFlat, //< Flat shading
|
||||
rmGouraud, //< Gouraud shading
|
||||
rmPhong //< Phong shading
|
||||
rmFlat, //!< Flat shading
|
||||
rmGouraud, //!< Gouraud shading
|
||||
rmPhong //!< Phong shading
|
||||
};
|
||||
|
||||
static const NamedEnum<renderModeType, 3> renderModeTypeNames;
|
||||
|
||||
@ -65,8 +65,8 @@ public:
|
||||
|
||||
enum representationType
|
||||
{
|
||||
rtSphere, //< Sphere
|
||||
rtVector //< Vector
|
||||
rtSphere, //!< Sphere
|
||||
rtVector //!< Vector
|
||||
};
|
||||
|
||||
static const NamedEnum<representationType, 2> representationTypeNames;
|
||||
|
||||
@ -60,8 +60,8 @@ public:
|
||||
|
||||
enum operatingMode
|
||||
{
|
||||
omMin, //< Minimum
|
||||
omMax //< Maximum
|
||||
omMin, //!< Minimum
|
||||
omMax //!< Maximum
|
||||
};
|
||||
|
||||
static const NamedEnum<operatingMode, 2> operatingModeNames;
|
||||
|
||||
@ -64,8 +64,8 @@ public:
|
||||
// Mode type
|
||||
enum modeType
|
||||
{
|
||||
mdMin, //< Minimum
|
||||
mdMax //< Maximum
|
||||
mdMin, //!< Minimum
|
||||
mdMax //!< Maximum
|
||||
};
|
||||
|
||||
static const NamedEnum<modeType, 2> modeTypeNames_;
|
||||
|
||||
Reference in New Issue
Block a user