SUBROUTINE TYPE241 (TIME,XIN,OUT,T,DTDT,PAR,INFO,ICNTRL,*) !************************************************************************ ! Object: Rainwater Tank ! Simulation Studio Model: Rainwater Tank ! ! Author: Francesco Stella ! Editor: ! Date: April 16, 2012 last modified: April 16, 2012 ! ! ! *** ! *** Model Parameters ! *** ! Capacity m^3 [0;+Inf] ! Level lower limit m^3 [0;+Inf] ! Level post recovery m^3 [0;+Inf] ! Starting level m^3 [0;+Inf] !*** !*** Model Inputs !*** ! Balance m^3 [-Inf;+Inf] !*** !*** Model Outputs !*** ! Filling tank m^3 [-inf;+Inf] ! Overflow water m^3 [0;+Inf] ! Recovery water m^3 [0;+Inf] !*** !*** Model Derivatives !*** !(Comments and routine interface generated by TRNSYS Studio) !************************************************************************ ! TRNSYS acess functions (allow to acess TIME etc.) USE TrnsysConstants USE TrnsysFunctions !---------------------------------------------------------------------------------------------------------------------- ! REQUIRED BY THE MULTI-DLL VERSION OF TRNSYS !DEC$ATTRIBUTES DLLEXPORT :: TYPE241 !SET THE CORRECT TYPE NUMBER HERE !---------------------------------------------------------------------------------------------------------------------- !---------------------------------------------------------------------------------------------------------------------- ! TRNSYS DECLARATIONS IMPLICIT NONE !REQUIRES THE USER TO DEFINE ALL VARIABLES BEFORE USING THEM DOUBLE PRECISION XIN !THE ARRAY FROM WHICH THE INPUTS TO THIS TYPE WILL BE RETRIEVED DOUBLE PRECISION OUT !THE ARRAY WHICH WILL BE USED TO STORE THE OUTPUTS FROM THIS TYPE DOUBLE PRECISION TIME !THE CURRENT SIMULATION TIME - YOU MAY USE THIS VARIABLE BUT DO NOT SET IT! DOUBLE PRECISION PAR !THE ARRAY FROM WHICH THE PARAMETERS FOR THIS TYPE WILL BE RETRIEVED DOUBLE PRECISION STORED !THE STORAGE ARRAY FOR HOLDING VARIABLES FROM TIMESTEP TO TIMESTEP DOUBLE PRECISION T !AN ARRAY CONTAINING THE RESULTS FROM THE DIFFERENTIAL EQUATION SOLVER DOUBLE PRECISION DTDT !AN ARRAY CONTAINING THE DERIVATIVES TO BE PASSED TO THE DIFF.EQ. SOLVER INTEGER*4 INFO(15) !THE INFO ARRAY STORES AND PASSES VALUABLE INFORMATION TO AND FROM THIS TYPE INTEGER*4 NP,NI,NOUT,ND !VARIABLES FOR THE MAXIMUM NUMBER OF PARAMETERS,INPUTS,OUTPUTS AND DERIVATIVES INTEGER*4 NPAR,NIN,NDER !VARIABLES FOR THE CORRECT NUMBER OF PARAMETERS,INPUTS,OUTPUTS AND DERIVATIVES INTEGER*4 IUNIT,ITYPE !THE UNIT NUMBER AND TYPE NUMBER FOR THIS COMPONENT INTEGER*4 ICNTRL !AN ARRAY FOR HOLDING VALUES OF CONTROL FUNCTIONS WITH THE NEW SOLVER INTEGER*4 NSTORED !THE NUMBER OF VARIABLES THAT WILL BE PASSED INTO AND OUT OF STORAGE CHARACTER*3 OCHECK !AN ARRAY TO BE FILLED WITH THE CORRECT VARIABLE TYPES FOR THE OUTPUTS CHARACTER*3 YCHECK !AN ARRAY TO BE FILLED WITH THE CORRECT VARIABLE TYPES FOR THE INPUTS !---------------------------------------------------------------------------------------------------------------------- !---------------------------------------------------------------------------------------------------------------------- ! USER DECLARATIONS - SET THE MAXIMUM NUMBER OF PARAMETERS (NP), INPUTS (NI), ! OUTPUTS (NOUT), AND DERIVATIVES (ND) THAT MAY BE SUPPLIED FOR THIS TYPE PARAMETER (NP=4,NI=1,NOUT=3,ND=0,NSTORED=0) !---------------------------------------------------------------------------------------------------------------------- !---------------------------------------------------------------------------------------------------------------------- ! REQUIRED TRNSYS DIMENSIONS DIMENSION XIN(NI),OUT(NOUT),PAR(NP),YCHECK(NI),OCHECK(NOUT),STORED(NSTORED),T(ND),DTDT(ND) INTEGER NITEMS !---------------------------------------------------------------------------------------------------------------------- !---------------------------------------------------------------------------------------------------------------------- ! ADD DECLARATIONS AND DEFINITIONS FOR THE USER-VARIABLES HERE ! PARAMETERS DOUBLE PRECISION CAPACITY DOUBLE PRECISION LEVELlowerLIMIT DOUBLE PRECISION LEVELpostRECOVERY DOUBLE PRECISION STARTINGlevel ! INPUTS DOUBLE PRECISION BALANCE ! OUTPUTS DOUBLE PRECISION FILLINGtank DOUBLE PRECISION OVERFLOWwater DOUBLE PRECISION RECOVERYwater !---------------------------------------------------------------------------------------------------------------------- ! READ IN THE VALUES OF THE PARAMETERS IN SEQUENTIAL ORDER CAPACITY=PAR(1) LEVELlowerLIMIT=PAR(2) LEVELpostRECOVERY=PAR(3) STARTINGlevel=PAR(4) !---------------------------------------------------------------------------------------------------------------------- ! RETRIEVE THE CURRENT VALUES OF THE INPUTS TO THIS MODEL FROM THE XIN ARRAY IN SEQUENTIAL ORDER BALANCE=XIN(1) IUNIT=INFO(1) ITYPE=INFO(2) !---------------------------------------------------------------------------------------------------------------------- ! SET THE VERSION INFORMATION FOR TRNSYS IF(INFO(7).EQ.-2) THEN INFO(12)=16 RETURN 1 ENDIF !---------------------------------------------------------------------------------------------------------------------- !---------------------------------------------------------------------------------------------------------------------- ! DO ALL THE VERY LAST CALL OF THE SIMULATION MANIPULATIONS HERE IF (INFO(8).EQ.-1) THEN RETURN 1 ENDIF !---------------------------------------------------------------------------------------------------------------------- !---------------------------------------------------------------------------------------------------------------------- ! PERFORM ANY 'AFTER-ITERATION' MANIPULATIONS THAT ARE REQUIRED HERE ! e.g. save variables to storage array for the next timestep IF (INFO(13).GT.0) THEN NITEMS=0 ! STORED(1)=... (if NITEMS > 0) ! CALL setStorageVars(STORED,NITEMS,INFO) RETURN 1 ENDIF ! !---------------------------------------------------------------------------------------------------------------------- !---------------------------------------------------------------------------------------------------------------------- ! DO ALL THE VERY FIRST CALL OF THE SIMULATION MANIPULATIONS HERE IF (INFO(7).EQ.-1) THEN ! SET SOME INFO ARRAY VARIABLES TO TELL THE TRNSYS ENGINE HOW THIS TYPE IS TO WORK INFO(6)=NOUT INFO(9)=1 INFO(10)=0 !STORAGE FOR VERSION 16 HAS BEEN CHANGED ! SET THE REQUIRED NUMBER OF INPUTS, PARAMETERS AND DERIVATIVES THAT THE USER SHOULD SUPPLY IN THE INPUT FILE ! IN SOME CASES, THE NUMBER OF VARIABLES MAY DEPEND ON THE VALUE OF PARAMETERS TO THIS MODEL.... NIN=NI NPAR=NP NDER=ND ! CALL THE TYPE CHECK SUBROUTINE TO COMPARE WHAT THIS COMPONENT REQUIRES TO WHAT IS SUPPLIED IN ! THE TRNSYS INPUT FILE CALL TYPECK(1,INFO,NIN,NPAR,NDER) ! SET THE NUMBER OF STORAGE SPOTS NEEDED FOR THIS COMPONENT NITEMS=0 ! CALL setStorageSize(NITEMS,INFO) ! RETURN TO THE CALLING PROGRAM RETURN 1 ENDIF !---------------------------------------------------------------------------------------------------------------------- !---------------------------------------------------------------------------------------------------------------------- ! DO ALL OF THE INITIAL TIMESTEP MANIPULATIONS HERE - THERE ARE NO ITERATIONS AT THE INTIAL TIME IF (TIME .LT. (getSimulationStartTime() + getSimulationTimeStep()/2.D0)) THEN ! SET THE UNIT NUMBER FOR FUTURE CALLS IUNIT=INFO(1) ITYPE=INFO(2) ! CHECK THE PARAMETERS FOR PROBLEMS AND RETURN FROM THE SUBROUTINE IF AN ERROR IS FOUND ! IF(...) CALL TYPECK(-4,INFO,0,"BAD PARAMETER #",0) ! PERFORM ANY REQUIRED CALCULATIONS TO SET THE INITIAL VALUES OF THE OUTPUTS HERE ! OUT(1)=FILLINGtank ! OUT(2)=OVERFLOWwater ! OUT(3)=RECOVERYwater ! PERFORM ANY REQUIRED CALCULATIONS TO SET THE INITIAL STORAGE VARIABLES HERE NITEMS=0 ! STORED(1)=... ! PUT THE STORED ARRAY IN THE GLOBAL STORED ARRAY ! CALL setStorageVars(STORED,NITEMS,INFO) ! RETURN TO THE CALLING PROGRAM RETURN 1 ENDIF !---------------------------------------------------------------------------------------------------------------------- !---------------------------------------------------------------------------------------------------------------------- ! *** ITS AN ITERATIVE CALL TO THIS COMPONENT *** !---------------------------------------------------------------------------------------------------------------------- !---------------------------------------------------------------------------------------------------------------------- ! RETRIEVE THE VALUES IN THE STORAGE ARRAY FOR THIS ITERATION ! NITEMS= ! CALL getStorageVars(STORED,NITEMS,INFO) ! STORED(1)= !---------------------------------------------------------------------------------------------------------------------- !---------------------------------------------------------------------------------------------------------------------- ! CHECK THE INPUTS FOR PROBLEMS ! IF(...) CALL TYPECK(-3,INFO,'BAD INPUT #',0,0) ! IF(IERROR.GT.0) RETURN 1 !---------------------------------------------------------------------------------------------------------------------- !---------------------------------------------------------------------------------------------------------------------- ! *** PERFORM ALL THE CALCULATION HERE FOR THIS MODEL. *** !---------------------------------------------------------------------------------------------------------------------- FILLINGtank=STARTINGlevel FILLINGtank=FILLINGtank + BALANCE IF (FILLINGtank < LEVELlowerLIMIT) THEN RECOVERYwater = 0.25 * CAPACITY - FILLINGtank WRITE(*,*) 'RECOVERYwater = ', RECOVERYwater FILLINGtank = 0.25 * CAPACITY RETURN ELSE IF (FILLINGtank > CAPACITY) THEN OVERFLOWwater = FILLINGtank - (1.00 * CAPACITY) WRITE(*,*) 'OVERFLOWwater = ', OVERFLOWwater FILLINGtank = 1.00 * CAPACITY END IF WRITE(*,*) 'FILLINGtank = ', FILLINGtank !---------------------------------------------------------------------------------------------------------------------- ! SET THE OUTPUTS FROM THIS MODEL IN SEQUENTIAL ORDER AND GET OUT OUT(1)=FILLINGtank OUT(2)=OVERFLOWwater OUT(3)=RECOVERYwater !---------------------------------------------------------------------------------------------------------------------- ! EVERYTHING IS DONE - RETURN FROM THIS SUBROUTINE AND MOVE ON RETURN 1 END !----------------------------------------------------------------------------------------------------------------------