Differences

This shows you the differences between two versions of the page.

Link to this comparison view

execution_policy [2020/04/27 16:31]
argemiro created
execution_policy [2026/08/28 03:17] (current)
hermann Sync from local documentation review
Line 3: Line 3:
 ===== Description ===== ===== Description =====
  
-This functor ​executes ​contained functor using a specified processor policy+This container ​executes ​the functors it contains under a specified processor ​and parallelization ​policy, temporarily overriding the policy otherwise in effect for as long as its content runs.
  
 ===== Inputs ===== ===== Inputs =====
  
-^ Name            ^ Type                                      ^ Description ​                                                    ​+None. 
-| Maximum Granularity | [[non_negative_integer_value_type|Non Negative Integer Value]] ​ | Maximum granularity used to split a job in parallel ​task. Set 0 for default. | + 
-| Force Specified Granularity | [[boolean_value_type|Boolean Value]] | Use strictly ​the specified granularity. | +===== Optional Inputs ===== 
-| Computing ​target ​| Enum | Flag defining how the execution of the contained functors should be handled"Default" ​suggests the use  of accelerator computing devices, ​if they area avaliable, but also the use of regular ​workers: "Processors ​only" ​forces the use of regular ​workers"Accelerator Devices Only" ​forces the use of accelerator computing devices, ​but might raise execution ​errors ​if there are not any such devices ​available. |+ 
 +^ Name  ^ Type  ^ Description ​ ^ Default Value  ​
 +| Maximum Granularity ​ | [[Non Negative Integer Value Type]]  | Maximum granularity used to split a job into parallel ​tasks. Set to to use the default ​granularity | 0  ​
 +| Force Specified Granularity ​ | [[Boolean Value Type]]  Always use the granularity ​specified ​in Maximum Granularity,​ even when the current ​granularity ​is already within that limit | No  ​
 +| Computing ​Target  ​[[Enum Type]]  ​How the contained functors should be run: Default suggests the use of accelerator computing devices ​when availablewhile still allowing ​regular ​processors to be used; Processors ​Only forces the use of regular ​processors; Accelerator Devices Only forces the use of accelerator computing devices, ​and raises an error during ​execution if none are available. ​ | None  ​|
  
 ===== Outputs ===== ===== Outputs =====
  
-Functor doesn'​t have any outputs ports+None.
  
 ===== Group ===== ===== Group =====
  
 [[Functor List#​Control | Control]] [[Functor List#​Control | Control]]
 +
 +===== Notes =====
 +
 +This functor was previously known as "​ProcessorPolicy"​.
 +
 +The policy in effect before this container ran is always restored once its content finishes executing, whether or not an error occurs.
  
 ===== Internal Name ===== ===== Internal Name =====
  
-executionPolicy+ExecutionPolicy