time_loop.c File Reference

#include "adh.h"

Functions
int	time_loop (SMODEL_DESIGN *dm)
	This function performs the time loop on a design model (array of super models) More...
int	advance_time (SMODEL_DESIGN *dm, int nsuper)
	This function advances each super model by calling the forward stepper of the super model. More...
int	update_dt (SMODEL_DESIGN *dm)
	This function updates time and potentially the dt based on time series input super model. More...

Detailed Description

This file has functions responsible for running an array of supermodels in time

Function Documentation

advance_time()

int advance_time	(	SMODEL_DESIGN *	dm,
		int	nsuper
	)

This function advances each super model by calling the forward stepper of the super model.

Author

Count Corey J. Trahan

Mark Loveland

Bug:

none

Warning

none

Copyright

AdH

Parameters

[in,out]	dm	(SMODEL_DESIGN*) - the design model where the supermodels are
[in]	nsuper	(int) - number of super models to call

Returns

- potentially an error code of whether the time step was succesfull or not

time_loop()

int time_loop

(

SMODEL_DESIGN *

dm

)

This function performs the time loop on a design model (array of super models)

Author

Count Corey J. Trahan

Mark Loveland

Bug:

none

Warning

none

Copyright

AdH

Parameters

[in,out]

dm

(SMODEL_DESIGN*) - the design model where the supermodels are

update_dt()

int update_dt

(

SMODEL_DESIGN *

dm

)

This function updates time and potentially the dt based on time series input super model.

Author

Count Corey J. Trahan

Mark Loveland

Bug:

none

Warning

none

Copyright

AdH

Parameters

[in,out]

dm

(SMODEL_DESIGN*) - the design model where the supermodels are

Returns

- False if final time is passed. true if final time is not passed.