inp::OneOf Struct Reference

A quantity that can be given in more than one way. More...

#include <deckField.h>

Collaboration diagram for inp::OneOf:

Data Fields
std::string	what
	What the group gives, named in the error message.
std::vector< std::string >	keys
	Keys of the group.
bool	required = true
	Whether one of the keys has to be given.

Detailed Description

A quantity that can be given in more than one way.

The horizon is given either as Horizon or as Horizon_Mesh_Ratio. The contact stiffness is given either as Kn or as V_Max with Delta_Max. Before these groups were declared, the choice was recorded by giving the unused key a value outside its range, -1 or a number below 1e-10, and the reader decided which had been meant by comparing against that. A value outside the range is then not available as a value, and a deck that sets neither key or both is accepted.

Definition at line 299 of file deckField.h.

Field Documentation

keys

std::vector<std::string> inp::OneOf::keys

Keys of the group.

Definition at line 305 of file deckField.h.

required

bool inp::OneOf::required = true

Whether one of the keys has to be given.

Definition at line 308 of file deckField.h.

what

std::string inp::OneOf::what

What the group gives, named in the error message.

Definition at line 302 of file deckField.h.

---

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

• /home/user/project/src/inp/deckField.h