IntegrationScheme< Type >::integrationResult Class Reference

Helper class to supply results of integration. More...

Public Member Functions
	integrationResult ()
	Constructor. More...
Type	value () const
	Return const access to the value. More...
Type	average () const
	Return const access to the average. More...
Type &	value ()
	Return access to the value for changing. More...
Type &	average ()
	Return access to the average for changing. More...

Private Attributes
Type	value_
	Integration value. More...
Type	average_
	Average value across integration step. More...

Detailed Description

template<class Type>
class Foam::IntegrationScheme< Type >::integrationResult

Helper class to supply results of integration.

Definition at line 57 of file IntegrationScheme.H.

Constructor & Destructor Documentation

integrationResult()

integrationResult ( )

inline

Constructor.

Definition at line 69 of file IntegrationScheme.H.

Member Function Documentation

value() [1/2]

Type value ( ) const

inline

Return const access to the value.

Definition at line 81 of file IntegrationScheme.H.

References IntegrationScheme< Type >::integrationResult::value_.

Referenced by KinematicParcel::calcVelocity(), Euler< Type >::integrate(), and Analytical< Type >::integrate().

Here is the caller graph for this function:

average() [1/2]

Type average ( ) const

inline

Return const access to the average.

Definition at line 87 of file IntegrationScheme.H.

References IntegrationScheme< Type >::integrationResult::average_.

Referenced by KinematicParcel::calcVelocity(), Euler< Type >::integrate(), and Analytical< Type >::integrate().

Here is the caller graph for this function:

value() [2/2]

Type& value ( )

inline

Return access to the value for changing.

Definition at line 96 of file IntegrationScheme.H.

References IntegrationScheme< Type >::integrationResult::value_.

average() [2/2]

Type& average ( )

inline

Return access to the average for changing.

Definition at line 102 of file IntegrationScheme.H.

References IntegrationScheme< Type >::integrationResult::average_.

Field Documentation

value_

Type value_

private

Integration value.

Definition at line 60 of file IntegrationScheme.H.

Referenced by IntegrationScheme< Type >::integrationResult::value().

average_

Type average_

private

Average value across integration step.

Definition at line 63 of file IntegrationScheme.H.

Referenced by IntegrationScheme< Type >::integrationResult::average().

---

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

• src/lagrangian/intermediate/IntegrationScheme/IntegrationScheme/IntegrationScheme.H