ARTS built-in documentation server

Workspace Method ForLoop

Description

A simple for-loop.

This method is handy when you quickly want to test out a calculation
with a set of different settings.

It does a for-loop from start to stop in steps of step (who would
have guessed that). For each iteration, the agenda forloop_agenda is
executed. Inside the agenda, the variable forloop_index is available
as index counter.

There are no other inputs to forloop_agenda, and also no outputs. That
means, if you want to get any results out of this loop, you have to
save it to files (for example with WriteXMLIndexed), since
variables used inside the agenda will only be local.

Note that this kind of for loop is not parallel.

The method is intended for simple testing, not as a replacement of
ybatchCalc. However, it is compatible with ybatchCalc, in the sense
that ybatchCalc may occur inside forloop_agenda.

Authors: Stefan Buehler

Synopsis

ForLoop(

forloop_agenda, start, stop, step )

Variables

IN	forloop_agenda	(Agenda)	Agenda performing a for loop.
GIN	start	(Index)	Start value.
GIN	stop	(Index)	End value.
GIN	step	(Index)	Step size.