// ------------------------------------------------------------------------ // // SPDX-License-Identifier: LGPL-2.1-or-later // Copyright (C) 2007 - 2020 by the deal.II authors // // This file is part of the deal.II library. // // Part of the source code is dual licensed under Apache-2.0 WITH // LLVM-exception OR LGPL-2.1-or-later. Detailed license information // governing the source code and code contributions can be found in // LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II. // // ------------------------------------------------------------------------ #ifndef dealii_data_component_interpretation_h #define dealii_data_component_interpretation_h #include DEAL_II_NAMESPACE_OPEN /** * A namespace solely for the declaration of the * DataComponentInterpretation::DataComponentInterpretation enum. */ namespace 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. */ enum DataComponentInterpretation { /** * Indicates that a component of a data set corresponds to a scalar field * independent of the others. */ component_is_scalar, /** * Indicates that a component of a data set is part of a vector-valued * quantity. */ component_is_part_of_vector, /** * Indicates that a component of a data set is part of a tensor-valued * (2nd order) quantity. */ component_is_part_of_tensor }; } // namespace DataComponentInterpretation DEAL_II_NAMESPACE_CLOSE #endif