RichardsSumQuantity Class Reference

Sums into _total This is used, for instance, to record the total mass flowing into a borehole. More...

#include <RichardsSumQuantity.h>

Inheritance diagram for RichardsSumQuantity:

Public Member Functions
	RichardsSumQuantity (const InputParameters &parameters)
virtual	~RichardsSumQuantity ()
void	zero ()
	sets _total = 0 More...
void	add (Real contrib)
	adds contrib to _total More...
virtual void	initialize ()
	does nothing More...
virtual void	execute ()
	does nothing More...
virtual void	finalize ()
	does MPI gather on _total More...
virtual Real	getValue () const
	returns _total More...

Protected Attributes
Real	_total
	this holds the sum More...

Detailed Description

Sums into _total This is used, for instance, to record the total mass flowing into a borehole.

This is a suboptimal setup because it requires a const_cast of a RichardsSumQuantity object in order to do the summing

Definition at line 26 of file RichardsSumQuantity.h.

Constructor & Destructor Documentation

RichardsSumQuantity()

RichardsSumQuantity::RichardsSumQuantity

(

const InputParameters &

parameters

)

Definition at line 23 of file RichardsSumQuantity.C.

  : GeneralUserObject(parameters), _total(0)
{
}

~RichardsSumQuantity()

RichardsSumQuantity::~RichardsSumQuantity ( )

virtual

Definition at line 28 of file RichardsSumQuantity.C.

{}

Member Function Documentation

add()

void RichardsSumQuantity::add

(

Real

contrib

)

adds contrib to _total

Parameters

contrib

the amount to add to _total

Definition at line 37 of file RichardsSumQuantity.C.

{
  _total += contrib;
}

Referenced by RichardsPolyLineSink::computeQpResidual(), Q2PBorehole::computeQpResidual(), and RichardsBorehole::computeQpResidual().

execute()

void RichardsSumQuantity::execute ( )

virtual

does nothing

Definition at line 48 of file RichardsSumQuantity.C.

{
}

finalize()

void RichardsSumQuantity::finalize ( )

virtual

does MPI gather on _total

Definition at line 53 of file RichardsSumQuantity.C.

{
  gatherSum(_total);
}

getValue()

Real RichardsSumQuantity::getValue ( ) const

virtual

returns _total

Definition at line 59 of file RichardsSumQuantity.C.

{
  return _total;
}

Referenced by RichardsPlotQuantity::getValue().

initialize()

void RichardsSumQuantity::initialize ( )

virtual

does nothing

Definition at line 43 of file RichardsSumQuantity.C.

{
}

zero()

void RichardsSumQuantity::zero

(

)

sets _total = 0

Definition at line 31 of file RichardsSumQuantity.C.

{
  _total = 0;
}

Referenced by RichardsPolyLineSink::addPoints(), PeacemanBorehole::addPoints(), and PeacemanBorehole::PeacemanBorehole().

Member Data Documentation

_total

Real RichardsSumQuantity::_total

protected

this holds the sum

Definition at line 55 of file RichardsSumQuantity.h.

Referenced by add(), finalize(), getValue(), and zero().

---

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

• richards/include/userobjects/RichardsSumQuantity.h
• richards/src/userobjects/RichardsSumQuantity.C