def __init__(self, quantity, support, name=None, unit=None, where=None):
"""
ExpectedOutput initialisation with :
- an expected output quantity.
It can be Head, Flowrate, Pressure, Flux, DarcyVelocity, TotalFlux or
TotalInflux
- a support. Support depends on wanted quantity.
If Head, Pressure or DarcyVelocity, support can be bodies,
StructuredMesh or AbstractPoint
If Flux, support is a tuple (boundary, zone) (possible type for
boundary or for zone : Body or StructuredMesh)
zone orientates the boundary to calculate flux (outgoing normal positive)
If TotalFlux or TotalInflux, support can be bodies or StructuredMesh
- OPTIONAL :
--> a name (string). If none given, name is set to quantity
--> a unit (string)
--> where (string) : represents expected output localisation. It's only
available is quantity is Flowrate or DarcyVelocity
and support is bodies or StructuredMesh and on all elements.
Value can be center, face or border
"""
alltype = [
'Head', 'Pressure', 'Flux', 'DarcyVelocity', 'TotalFlux',
'TotalInflux'
]
facetype = ['DarcyVelocity']
CommonExpectedOutput.__init__(self, alltype, facetype, quantity,
support, name, unit, None, where)
def __init__(self,
quantity,
support,
name=None,
unit=None,
timeSpecification=None,
where=None,
save='memory'):
"""ExpectedOutput initialisation with :
- an expected output quantity.
It can be Head, Pressure, Flux, DarcyVelocity, TotalFlux, TotalInflux or Saturation
- a support. Support depends on wanted quantity.
If Flowrate, Pressure, Saturation or DarcyVelocity, support can be Support, StructuredMesh or AbstractPoint
If Flux, support is a tuple (boundary, zone) (possible type for
boundary or for zone : Support or StructuredMesh)
If TotalFlux or TotalInflux, support can be Support or StructuredMesh
- OPTIONAL :
--> a name (string). If none given, name is set to quantity
--> a unit (string)
--> where (string) : represents expected output localisation. It's only
available is quantity is DarcyVelocity and support is Support
or StructuredMesh and on all elements.
Value can be center, face or border
--> timeSpecification (TimeSpecification) : define times to get expected output
"""
alltype = [
'Head', 'Pressure', 'Flux', 'DarcyVelocity', 'TotalFlux',
'TotalInflux', 'Saturation'
]
facetype = ['DarcyVelocity']
CommonExpectedOutput.__init__(self, alltype, facetype, quantity,
support, name, unit, timeSpecification,
where, [], save)
def __init__(self, quantity, support, name = None, unit=None,timeSpecification=None,where=None):
"""ExpectedOutput initialisation with :
- an expected output quantity.
It can be Flowrate, Pressure, Flux, DarcyVelocity, TotalFlux or TotalInflux
- a support. Support depends on wanted quantity.
If Pressure or DarcyVelocity, support can be StructuredMesh or AbstractPoint
If Flux, support is a tuple (boundary, zone) (possible type for
boundary or for zone : StructuredMesh)
If TotalFlux or TotalInflux, support can be StructuredMesh
- OPTIONAL :
--> a name (string). If none given, name is set to quantity
--> a unit (string)
--> where (string) : represents expected output localisation. It's only
available is quantity is Pressure or DarcyVelocity
and support is StructuredMesh and on all elements.
Value can be center, face or border
--> timeSpecification (TimeSpecification) : define times to get expected output
"""
alltype = ['Pressure','Flux', 'DarcyVelocity','TotalFlux','TotalInflux']
facetype = ['DarcyVelocity']
CommonExpectedOutput.__init__(self,alltype,facetype,quantity, support, name , unit,timeSpecification,where)
