| |
- Method resolution order:
- LinearChannelProcedureFunction
- pydrodelta.procedures.generic_linear_channel.GenericLinearChannelProcedureFunction
- pydrodelta.procedure_function.ProcedureFunction
- builtins.object
Methods defined here:
- __init__(self, **kwargs)
- Nash linear channel (gamma distribution)
Parameters:
-----------
/**kwargs : keyword arguments
Keyword arguments:
------------------
parameters : dict
properties:
k : float residence time
n : float number of reservoirs
extra_pars: dict
properties
dt : float calculation timestep
Readonly properties defined here:
- Proc
- Linear channel procedure
- coefficients
- Linear channel coefficients (k, n)
Methods inherited from pydrodelta.procedures.generic_linear_channel.GenericLinearChannelProcedureFunction:
- run(self, input: list = None) -> tuple
- Ejecuta la función. Si input es None, ejecuta self._procedure.loadInput para generar el input. input debe ser una lista de objetos SeriesData
Devuelve una lista de objetos SeriesData y opcionalmente un objeto ProcedureFunctionResults
Parameters:
-----------
input : list of DataFrames
Procedure function input (boundary conditions). If None, loads using .loadInput()
Returns:
--------
2-tuple : first element is the procedure function output (list of DataFrames), while second is a ProcedureFunctionResults object
Methods inherited from pydrodelta.procedure_function.ProcedureFunction:
- makeSimplex(self, sigma: float = 0.25, limit: bool = True, ranges: Optional[list] = None) -> list
- Generate Simplex from procedure function parameters.
Generates a list of len(self._parameters)+1 parameter sets randomly using a normal distribution centered in the corresponding parameter range and with variance=sigma
Parameters:
-----------
sigma : float (default 0.25)
Variance of the normal distribution relative to the range(1 = max_range - min_range)
limit : bool (default True)
Truncate values outside of the min-max range
ranges : list or None
Override parameter ranges with these values. Length must be equal to self._parameters and each element of the list must be a 2-tuple (range_min, range_max)
Returns:
--------
list : list of length = len(self._parameters) + 1 where each element is a list of floats of length = len(self._parameters)
- rerun(self, input: list = None, parameters: Union[list, tuple] = None, initial_states: Union[list, tuple] = None) -> Tuple[list, dict]
- Execute the procedure function with the given parameters and initial_states
Parameters:
-----------
input : list if DataFrames
Procedure function input (boundary conditions). If None, loads using .loadInput()
parameters : list or tuple
Set procedure function parameters (self.parameters).
initial_states : list or tuple
Set initial states (self.initial_states)
Returns:
--------
2-tuple : first element is the procedure function output (list of DataFrames), while second is a ProcedureFunctionResults object
- setBoundaries(self, boundaries: list = []) -> None
- Setter of boundaries
Parameters:
----------
boundaries : list
List of boundary conditions. Each item is a dict with a name <string> and a node_variable <NodeVariableIdTuple>. The node_variables must map to plan.topology.nodes[node_id].variables[variable_id]
- setInitialStates(self, states: Union[list, tuple] = []) -> None
- Generic self.initial_states setter. If self._states is not empty, uses name of each item to set self.initial_states as a dict. Else will set a list
Parameters:
states : list or tuple
Procedure function initial states to set
- setOutputs(self, outputs: list = []) -> None
- Setter for outputs
Parameters:
-----------
outputs : list of dict
list of procedure outputs. Each item is a dict with a name <string> and a node_variable tuple <NodeVariableIdTuple>. The node_variables must map to plan.topology.nodes[node_id].variables[variable_id]
- setParameters(self, parameters: Union[list, tuple] = []) -> None
- Generic self.parameters setter. If self._parameters is not empty, uses name of each item to set self.parameters as a dict. Else will set a list
Parameters:
-----------
parameters : list or tuple
Procedure function parameters to set
- toDict(self) -> dict
- Convert this procedureFunction to a dict
Returns:
--------
dict
Data descriptors inherited from pydrodelta.procedure_function.ProcedureFunction:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|