PorousFlowSumQuantity Class Reference

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

#include <PorousFlowSumQuantity.h>

Inheritance diagram for PorousFlowSumQuantity:

Public Member Functions
	PorousFlowSumQuantity (const InputParameters &parameters)
virtual	~PorousFlowSumQuantity ()
void	zero ()
	Sets _total = 0. More...
void	add (Real contrib)
	Adds contrib to _total. More...
virtual void	initialize () override
	Does nothing. More...
virtual void	execute () override
	Does nothing. More...
virtual void	finalize () override
	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 PorousFlowSumQuantity object in order to do the summing

Definition at line 26 of file PorousFlowSumQuantity.h.

Constructor & Destructor Documentation

PorousFlowSumQuantity()

PorousFlowSumQuantity::PorousFlowSumQuantity

(

const InputParameters &

parameters

)

Definition at line 23 of file PorousFlowSumQuantity.C.

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

~PorousFlowSumQuantity()

PorousFlowSumQuantity::~PorousFlowSumQuantity ( )

virtual

Definition at line 28 of file PorousFlowSumQuantity.C.

{}

Member Function Documentation

add()

void PorousFlowSumQuantity::add

(

Real

contrib

)

Adds contrib to _total.

Parameters

contrib

the amount to add to _total

Definition at line 37 of file PorousFlowSumQuantity.C.

{
  _total += contrib;
}

Referenced by PorousFlowLineSink::computeQpResidual().

execute()

void PorousFlowSumQuantity::execute ( )

overridevirtual

Does nothing.

Definition at line 48 of file PorousFlowSumQuantity.C.

{
}

finalize()

void PorousFlowSumQuantity::finalize ( )

overridevirtual

Does MPI gather on _total.

Definition at line 53 of file PorousFlowSumQuantity.C.

{
  gatherSum(_total);
}

getValue()

Real PorousFlowSumQuantity::getValue ( ) const

virtual

Returns _total.

Definition at line 59 of file PorousFlowSumQuantity.C.

{
  return _total;
}

Referenced by PorousFlowPlotQuantity::getValue().

initialize()

void PorousFlowSumQuantity::initialize ( )

overridevirtual

Does nothing.

Definition at line 43 of file PorousFlowSumQuantity.C.

{
}

zero()

void PorousFlowSumQuantity::zero

(

)

Sets _total = 0.

Definition at line 31 of file PorousFlowSumQuantity.C.

{
  _total = 0.0;
}

Referenced by PorousFlowLineSink::addPoints(), and PorousFlowLineSink::PorousFlowLineSink().

Member Data Documentation

_total

Real PorousFlowSumQuantity::_total

protected

This holds the sum.

Definition at line 55 of file PorousFlowSumQuantity.h.

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

---

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

• porous_flow/include/userobjects/PorousFlowSumQuantity.h
• porous_flow/src/userobjects/PorousFlowSumQuantity.C