Auxiliary information about quantity that aren't stored directly in Quantity. More...

#include <QuantityIds.h>

Public Member Functions
	QuantityMetadata (const std::string &fullName, const std::wstring &label, const ValueEnum type, const std::string &derivativeName="", const std::string &secondDerivativeName="")

Public Attributes
std::string	quantityName
	Full name of the quantity (i.e. 'Density', 'Deviatoric stress', ...) More...

std::string	derivativeName
	Name of the 1st derivative. More...

std::string	secondDerivativeName
	Name of the second derivative. More...

std::wstring	label
	Short designation of the quantity (i.e. 'rho', 's', ...). More...

ValueEnum	expectedType
	Variable expectedType contains a type the quantity will most likely have. More...

UnitDimensions	expectedUnit = BasicDimension::LENGTH

Detailed Description

Auxiliary information about quantity that aren't stored directly in Quantity.

Definition at line 239 of file QuantityIds.h.

Constructor & Destructor Documentation

◆ QuantityMetadata()

NAMESPACE_SPH_BEGIN QuantityMetadata::QuantityMetadata	(	const std::string &	fullName,
		const std::wstring &	label,
		const ValueEnum	type,
		const std::string &	derivativeName = `""`,
		const std::string &	secondDerivativeName = `""`
	)

Definition at line 6 of file QuantityIds.cpp.

Member Data Documentation

◆ derivativeName

std::string QuantityMetadata::derivativeName

Name of the 1st derivative.

Usually it's just quantityName + 'derivative', but not always (for example 'Velocity' instead of 'Position derivative')

Definition at line 248 of file QuantityIds.h.

◆ expectedType

ValueEnum QuantityMetadata::expectedType

Variable expectedType contains a type the quantity will most likely have.

Todo:: Units & dimensional analysis !

The code does not assign fixed types to quantities, i.e. it's possible to create a tensor quantity QuantityId::DENSITY. This allows to use different modifications of SPH (tensor artificial viscosity, etc.), even though most quantities have only one type in any meaningful SPH simulation (density will always be scalar, for example).

Definition at line 266 of file QuantityIds.h.

◆ expectedUnit

UnitDimensions QuantityMetadata::expectedUnit = BasicDimension::LENGTH

Definition at line 268 of file QuantityIds.h.

◆ label

std::wstring QuantityMetadata::label

Short designation of the quantity (i.e. 'rho', 's', ...).

Definition at line 256 of file QuantityIds.h.

◆ quantityName

std::string QuantityMetadata::quantityName

Full name of the quantity (i.e. 'Density', 'Deviatoric stress', ...)

Definition at line 242 of file QuantityIds.h.

◆ secondDerivativeName

std::string QuantityMetadata::secondDerivativeName

Name of the second derivative.

Usually it's just quantityName + '2nd derivative'

Definition at line 253 of file QuantityIds.h.

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

/home/pavel/projects/astro/sph/src/core/quantities/QuantityIds.h
/home/pavel/projects/astro/sph/src/core/quantities/QuantityIds.cpp

Public Member Functions

Public Attributes