DataComponentInterpretation Namespace Reference

Enumerations
enum	DataComponentInterpretation { component_is_scalar , component_is_part_of_vector , component_is_part_of_tensor , component_is_ignored }

Detailed Description

A namespace solely for the declaration of the DataComponentInterpretation::DataComponentInterpretation enum.

Enumeration Type Documentation

DataComponentInterpretation

enum DataComponentInterpretation::DataComponentInterpretation

The members of this enum are used to describe the logical interpretation of what the various components of a vector-valued data set mean. For example, if one has a finite element for the Stokes equations in 2d, representing components \((u,v,p)\), one would like to indicate that the first two, \(u\) and \(v\), represent a logical vector so that later on when we generate graphical output we can hand them off to a visualization program that will automatically know to render them as a vector field, rather than as two separate and independent scalar fields.

By passing a set of enums of the current kind to the DataOut_DoFData::add_data_vector functions, this can be achieved.

See the step-22 tutorial program for an example on how this information can be used in practice.

Enumerator
component_is_scalar	Indicates that a component of a data set corresponds to a scalar field independent of the others.
component_is_part_of_vector	Indicates that a component of a data set is part of a vector-valued quantity.
component_is_part_of_tensor	Indicates that a component of a data set is part of a tensor-valued (2nd order) quantity.
component_is_ignored	Indicates that a component is not to be written by DataOut_DoFData and its derived classes. A name must still be supplied for this component, but neither the name nor its values appear in the output. All components of a logical vector or tensor must either be retained or ignored.

Definition at line 44 of file data_component_interpretation.h.