Trigger

Frank Löffler <knarf@cct.lsu.edu>

October 23, 2012

Abstract

Trigger can be used to steer (change) parameters depending on data from the simulation. Examples would be enabling refinement levels when the density reaches a certain threshold or enabling output within a certain time window.

1 Parameters

2 Parameters




trigger_checked_parameter_name
Scope: private  STRING



Description: parameter name to be checked for



Range   Default: (none)
.+
parameter name
An empty string to trigger nothing






trigger_checked_parameter_thorn
Scope: private  STRING



Description: thorn of parameter to be checked for



Range   Default: (none)
.+
thorn name
An empty string to trigger nothing






trigger_checked_value
Scope: private  REAL



Description: triggered value for checked variable



Range   Default: 1.0
*:*
value to be triggered for






trigger_checked_variable
Scope: private  STRING



Description: variable to be checked for



Range   Default: (none)
.+
fully qualified variable name, ’param’ for a parameter
An empty string to trigger nothing






trigger_debug
Scope: private  INT



Description: turnes on debug messages



Range   Default: (none)
0:1
Only 0 (off, default) or 1 (on)






trigger_number
Scope: private  INT



Description: Number of triggers



Range   Default: (none)
0:10
The number of triggers that are defined






trigger_once
Scope: private  INT



Description: Should this trigger only be triggered (and checked) once?



Range   Default: (none)
0:1
0 (no), 1 (yes)






trigger_output_method
Scope: private  STRING



Description: IO-output method for this trigger



Range   Default: 1D
.+
an enabled IO-method
An empty string for no output






trigger_output_variables
Scope: private  STRING



Description: variable to be put out ’param’ for parameter



Range   Default: (none)
.+
Space-separated list of fully qualified variable name
An empty string to trigger nothing






trigger_reaction
Scope: private  KEYWORD



Description: how to react on a positive trigger



Range   Default: output
output
enable output
steerparam
steer parameter
steerscalar
steer grid scalar






trigger_reduction
Scope: private  STRING



Description: valid reduction method



Range   Default: (none)
.+
some relations e.g. ’norm2’
An empty string for no reduction (for scalars)






trigger_relation
Scope: private  STRING



Description: relation operator for checked variable



Range   Default: >
see [1] below
some relations



[1]

\^{\textless}|{\textgreater}|==|!=\$




trigger_steered_parameter_name
Scope: private  STRING



Description: parameter name to be changed



Range   Default: (none)
.+
parameter name
An empty string to change nothing






trigger_steered_parameter_thorn
Scope: private  STRING



Description: thorn of parameter to be changed



Range   Default: (none)
.+
thorn name
An empty string to change nothing






trigger_steered_parameter_value
Scope: private  STRING



Description: parameter value to be changed to



Range   Default: (none)
.+
parameter value
can be empty






trigger_steered_scalar
Scope: private  STRING



Description: Scalar to be changed



Range   Default: (none)
.+
scalar name
can be empty






trigger_steered_scalar_index
Scope: private  INT



Description: Scalar index to be changed



Range   Default: (none)
0:*
>=0






trigger_steered_scalar_value
Scope: private  STRING



Description: Scalar value to be changed to



Range   Default: (none)
.+
scalar value
can be empty



3 Interfaces

General

Implements:

trigger

Inherits:

io

Grid Variables

3.0.1 PRIVATE GROUPS




  Group Names    Variable Names    Details   




trigger_vars   compact0
trigger_cctk_iteration  descriptionScalars for the triggers
trigger_cctk_time   dimensions0
  distributionCONSTANT
  group typeSCALAR
  tagscheckpoint=”no”
  timelevels1
 variable typeREAL




4 Schedule

This section lists all the variables which are assigned storage by thorn CactusUtils/Trigger. Storage can either last for the duration of the run (Always means that if this thorn is activated storage will be assigned, Conditional means that if this thorn is activated storage will be assigned for the duration of the run if some condition is met), or can be turned on for the duration of a schedule function.

Storage

NONE

Scheduled Functions

CCTK_STARTUP

  trigger_startup

  startup routine

 

 Language:c
 Type: function

CCTK_PARAMCHECK

  trigger_paramcheck

  parameter checking

 

 Language:c
 Type: function

CCTK_ANALYSIS

  trigger_check

  test

 

 Before: ahfinderdirect_setupupdate
 Language:c
 Options: global-early
 Storage: trigger_vars
 Type: function