SetBoundaryConditionController

Add a new boundary control set. Boundary control sets can be addressed by the SetBoundaryControlSet command.

Usage: SetBoundaryConditionController -op <OPERATOR> [<BLOCK_GROUP>] <TARGET/FACTOR> <RELAXATION_START> [<RELAXATION_END> <RELAXATION_INTERVAL>] -cPanel <IDENTIFIER> -ePanel <IDENTIFIER...> [-it <START> [<STEP> [<N_TIMESTEPS>]]] [-o [<FILE_PATH>]] [-rst [<FILE_PATH>]] [-res <RESIDUAL>]

Long option	Short option	Arguments
`--operator`	`-op`	OPERATOR: One of `Scale`, `Shift`, `Multiply`, `PorousLoss`; BLOCK_GROUP: only required for `PorousLoss`; TARGET/FACTOR:Operator dependent; RELAXATION_START: relaxation factor [at start]; RELAXATION_END: relaxation factor at end RELAXATION_INTERVAL
`--controlPanel`	`-cPanel`	IDENTIFIER: Identifier defined in a SetBoundaryControlSet command
`--evaluationPanel`	`-ePanel`	IDENTIFIER: Identifier defined in a SetBoundaryControlSet command; minimum one, maximum three at the moment
`--iterationControl`	`-it`	START: Time step (relative) at which the controller starts; STEP: Controller is active every STEP iterations; N_TIMESTEPS: number of steps the controller is active
`--output`	`-o`	FILE_PATH: Path to a file the boundary condition controller output will be written into (Tecplot DAT format)
`--restart`	`-rst`	FILE_PATH: Controller restarts from controller output in FILE_PATH
`--residual`	`-res`	RESIDUAL: Target residual for the controller

The first three parameter are required.

The <RELAXATION_END> and <RELAXATION_INTERVAL> is optional to vary the relaxation factor linear between <RELAXATION_START> and <RELAXATION_END> in <RELAXATION_INTERVAL> steps. Without these parameters the relaxation factor keep constant at <RELAXATION_START>.

The <START> parameter is the only required parameter to the --iterationControl command. The <STEP> parameter can be given without providing <N_TIMESTEPS>, but if one wants to specify the <N_TIMESTEPS> parameter the <STEP> parameter is required as well.

The --output parameter allows to write controller specific data into an output file and restart from this file. If no <FILE_PATH> is provided, a default file name is chosen, suffixed with the controller number.

--restart allows to restart the controller from an output file of an earlier computation. It is tested, if the file´s entries match the described controller. If no <FILE_PATH> is provided the <FILE_PATH> of the --output parameter is used.

The --residual parameter allows o specify a target residual. If this parameter is not provided a default residual of \(10^{-3}\) is used.

To ensure a simulation does not converge, before a controller is converged, every controller is automatically added to TRACEs convergence control. If the user does not provide a custom residual via --residual keyword, a default residual of \(10^{-3}\) is used. When the user deactivates the controller via <N_TIMESTEPS> parameter, the residual of the controller is no longer considered for convergence control.

Domain: all

SetBoundaryControlSet

Add a new boundary control set. Boundary control sets can be addressed (via IDENTIFIER) by the SetBoundaryConditionController command.

Usage: SetBoundaryControlSet <IDENTIFIER> <PANEL_FAMILY_NAME> <VARIABLE_NAME> <AVERAGING>

Option	Description
IDENTIFIER	An unique user selected identifier; used later to address the control set
PANEL_FAMILY_NAME	Name of the panel family to control
VARIABLE_NAME	Name of the variable which will be controlled or used for evaluation
AVERAGING	Averaging used; Needs to be one of: `Flux`, `Mass` or `Area`

Domain: all

Example: all immediate SetBoundaryControlSet ControlPanel_PT INLET_INFLOW PressureStagnationAbs Flux

all immediate SetBoundaryControlSet EvaluationPanel_PT INLET_INFLOW MassFlow Flux