Metadata identifying one configured three-dimensional particle moment. More...

#include "part.hpp"

Collaboration diagram for orb5x::Moments3DClass:

Public Member Functions
void	construct (int id_, const std::string &label_, const std::string &desc_)
	Assign moment identity and display metadata.

Public Attributes
std::string	description
	Human-readable physical quantity description.

int	id
	Moment selector from prec_const.hpp.

std::string	label
	Short dataset/diagnostic label.

Detailed Description

Metadata identifying one configured three-dimensional particle moment.

Member Function Documentation

void orb5x::Moments3DClass::construct	(	int	id_,
		const std::string &	label_,
		const std::string &	desc_
	)

inline

Assign moment identity and display metadata.

Parameters

[in]	id_	Moment selector defined in prec_const.hpp.
[in]	label_	Short output-dataset label.
[in]	desc_	Human-readable physical description.

References description, and label.

std::string orb5x::Moments3DClass::description

Human-readable physical quantity description.

Referenced by construct().

int orb5x::Moments3DClass::id

Moment selector from prec_const.hpp.

std::string orb5x::Moments3DClass::label

Short dataset/diagnostic label.

Referenced by construct().

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