EvaluationFlags Namespace Reference

The namespace for the EvaluationFlags enum. More...

Enumerations
enum	EvaluationFlags { nothing = 0 , values = 0x1 , gradients = 0x2 , hessians = 0x4 }
	The EvaluationFlags enum. More...

Functions
EvaluationFlags	operator| (const EvaluationFlags f1, const EvaluationFlags f2)
EvaluationFlags &	operator|= (EvaluationFlags &f1, const EvaluationFlags f2)
EvaluationFlags	operator& (const EvaluationFlags f1, const EvaluationFlags f2)
EvaluationFlags &	operator&= (EvaluationFlags &f1, const EvaluationFlags f2)

Detailed Description

The namespace for the EvaluationFlags enum.

This namespace contains the enum EvaluationFlags used in FEEvaluation to control evaluation and integration of values, gradients, etc..

Enumeration Type Documentation

EvaluationFlags

enum EvaluationFlags::EvaluationFlags

The EvaluationFlags enum.

This enum contains a set of flags used by FEEvaluation::integrate(), FEEvaluation::evaluate() and others to determine if values, gradients, hessians, or a combination of them is being used.

Enumerator
nothing	Do not use or compute anything.
values	Use or evaluate values.
gradients	Use or evaluate gradients.
hessians	Use or evaluate hessians.

Definition at line 42 of file evaluation_flags.h.

Function Documentation

operator|()

EvaluationFlags EvaluationFlags::operator| ( const EvaluationFlags  f1, const EvaluationFlags  f2  )

inline

Global operator which returns an object in which all bits are set which are either set in the first or the second argument. This operator exists since if it did not then the result of the bit-or operator | would be an integer which would in turn trigger a compiler warning when we tried to assign it to an object of type UpdateFlags.

EvaluationFlags

Definition at line 73 of file evaluation_flags.h.

operator|=()

EvaluationFlags & EvaluationFlags::operator|= ( EvaluationFlags &  f1, const EvaluationFlags  f2  )

inline

Global operator which sets the bits from the second argument also in the first one.

EvaluationFlags

Definition at line 88 of file evaluation_flags.h.

operator&()

EvaluationFlags EvaluationFlags::operator& ( const EvaluationFlags  f1, const EvaluationFlags  f2  )

inline

Global operator which returns an object in which all bits are set which are set in the first as well as the second argument. This operator exists since if it did not then the result of the bit-and operator & would be an integer which would in turn trigger a compiler warning when we tried to assign it to an object of type UpdateFlags.

EvaluationFlags

Definition at line 105 of file evaluation_flags.h.

operator&=()

EvaluationFlags & EvaluationFlags::operator&= ( EvaluationFlags &  f1, const EvaluationFlags  f2  )

inline

Global operator which clears all the bits in the first argument if they are not also set in the second argument.

EvaluationFlags

Definition at line 119 of file evaluation_flags.h.