FieldFlag Class Reference

#include <field_flag.hh>

Inheritance diagram for FieldFlag:

Public Types
typedef FlagArray< FieldFlag >	Flags
typedef Flags::Mask	Mask

Static Public Attributes
static constexpr unsigned int	flags_size_ = 3
	Number of bits used by Field itself. More...
static constexpr Mask	equation_input {1 << 0}
	The field is data parameter of the owning equation. (default on) More...
static constexpr Mask	declare_input {1 << 1}
	The field can be set from input. The key in input field descriptor is declared. (default on) More...
static constexpr Mask	allow_output {1 << 2}
	The field can output. Is part of generated output selection. (default on) More...
static constexpr Mask	input_copy = ~declare_input & equation_input
static constexpr Mask	in_time_term {1 << 8}
	A field is part of time term of the equation. More...
static constexpr Mask	in_main_matrix {1 << 9}
	A field is part of main "stiffness matrix" of the equation. More...
static constexpr Mask	in_rhs {1 << 10}
	A field is part of the right hand side of the equation. More...
static constexpr Mask	equation_result = allow_output & ~declare_input & ~equation_input
	Match result fields. These are never given by input or copy of input. More...
static constexpr Mask	equation_external_output = allow_output & input_copy
	Match an output field, that can be also copy of other field. More...

Detailed Description

Definition at line 23 of file field_flag.hh.

Member Typedef Documentation

Flags

typedef FlagArray<FieldFlag> FieldFlag::Flags

Definition at line 26 of file field_flag.hh.

Mask

typedef Flags::Mask FieldFlag::Mask

Definition at line 27 of file field_flag.hh.

Member Data Documentation

allow_output

constexpr FieldFlag::Flags::Mask FieldFlag::allow_output {1 << 2}

staticconstexpr

The field can output. Is part of generated output selection. (default on)

Definition at line 37 of file field_flag.hh.

declare_input

constexpr FieldFlag::Flags::Mask FieldFlag::declare_input {1 << 1}

staticconstexpr

The field can be set from input. The key in input field descriptor is declared. (default on)

Definition at line 35 of file field_flag.hh.

equation_external_output

constexpr FieldFlag::Flags::Mask FieldFlag::equation_external_output = allow_output & input_copy

staticconstexpr

Match an output field, that can be also copy of other field.

Definition at line 58 of file field_flag.hh.

equation_input

constexpr FieldFlag::Flags::Mask FieldFlag::equation_input {1 << 0}

staticconstexpr

The field is data parameter of the owning equation. (default on)

Definition at line 33 of file field_flag.hh.

equation_result

constexpr FieldFlag::Flags::Mask FieldFlag::equation_result = allow_output & ~declare_input & ~equation_input

staticconstexpr

Match result fields. These are never given by input or copy of input.

Definition at line 55 of file field_flag.hh.

flags_size_

constexpr unsigned int FieldFlag::flags_size_ = 3

staticconstexpr

Number of bits used by Field itself.

Definition at line 30 of file field_flag.hh.

in_main_matrix

constexpr FieldFlag::Flags::Mask FieldFlag::in_main_matrix {1 << 9}

staticconstexpr

A field is part of main "stiffness matrix" of the equation.

Definition at line 49 of file field_flag.hh.

in_rhs

constexpr FieldFlag::Flags::Mask FieldFlag::in_rhs {1 << 10}

staticconstexpr

A field is part of the right hand side of the equation.

Definition at line 51 of file field_flag.hh.

in_time_term

constexpr FieldFlag::Flags::Mask FieldFlag::in_time_term {1 << 8}

staticconstexpr

A field is part of time term of the equation.

Definition at line 47 of file field_flag.hh.

input_copy

constexpr FieldFlag::Flags::Mask FieldFlag::input_copy = ~declare_input & equation_input

staticconstexpr

A field that is input of its equation and can not read from input, thus must be set by copy. Disabled flag 'declare_input' still allow initialization of the field from a default value.

Definition at line 44 of file field_flag.hh.

---

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

• /home/runner/work/flow123d/flow123d/src/fields/field_flag.hh
• /home/runner/work/flow123d/flow123d/src/fields/field_flag.cc