b2000::GradientContainer::FieldDescription Struct Reference

#include "b2solution.H"

Public Attributes
std::string	name
std::string	components_name
std::string	description
int	domain_ndim
int	nb_comp
int	tensor_order
int	tensor_size
bool	tensor_symmetric
const std::type_info &	elem_type

Detailed Description

Describes the kind of gradient data.

Example:

GradientContainer::FieldDescription descr = {
    "STRAIN",
    "Exx.Eyy.Ezz.Exy.Eyz.Exz",
    "Linear strain expressed in the branch-global system",
    3, 6, 2, 3, true, typeid(double)
};

Member Data Documentation

components_name

std::string b2000::GradientContainer::FieldDescription::components_name

The names of the components of the field, separated by periods (".").

description

std::string b2000::GradientContainer::FieldDescription::description

A short description of the field.

domain_ndim

int b2000::GradientContainer::FieldDescription::domain_ndim

The number of dimensions of the domain where the field is defined. 1 for fields defined on a line, 2 for fields defined on a surface, 3 for fields defined in a volume.

elem_type

const std::type_info& b2000::GradientContainer::FieldDescription::elem_type

The type of the values of the field.

name

std::string b2000::GradientContainer::FieldDescription::name

The name of the field. Names are unique.

nb_comp

int b2000::GradientContainer::FieldDescription::nb_comp

The number of components of the field. It must correspond with components_name.

tensor_order

int b2000::GradientContainer::FieldDescription::tensor_order

The tensor order of the field or -1 if the field is not a tensor.

tensor_size

int b2000::GradientContainer::FieldDescription::tensor_size

The tensor size of the field or -1 if the field is not a tensor.

tensor_symmetric

bool b2000::GradientContainer::FieldDescription::tensor_symmetric

True if the field is symmetric. Order 2 symmetric tensors are stored [x11, x22, x33, x12, x23, x13].

---

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

• model/b2solution.H