Package hedge :: Module log :: Class Integral
[hide private]
[frames] | no frames]

Class Integral

source code


Log the volume integral of a variable in a scope.

Instance Methods [hide private]
 
__init__(self, getter, discr, name=None, unit='1', description=None)
Construct the integral logger.
source code
 
__call__(self)
Return the current value of the diagnostic represented by this LogQuantity or None if no value is available.
source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties [hide private]
  default_aggregator

Inherited from object: __class__

Method Details [hide private]

__init__(self, getter, discr, name=None, unit='1', description=None)
(Constructor)

source code 

Construct the integral logger.

Parameters:
  • getter - a callable that returns the value of which to take the integral.
  • discr - a discretization.Discretization to which the variable belongs.
  • name - the name reported to the LogManager.
  • unit - the unit of measure for the log quantity.
  • description - A description fed to the LogManager.
Overrides: object.__init__

__call__(self)
(Call operator)

source code 

Return the current value of the diagnostic represented by this LogQuantity or None if no value is available.

Overrides: pytools.log.LogQuantity.__call__
(inherited documentation)

Property Details [hide private]

default_aggregator

Get Method:
unreachable.default_aggregator(self)