/* 
output_init.c
Reads output control information from initialization file

*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
Biome-BGC version 4.1.2
Copyright 2002, Peter E. Thornton

Revisions from version 4.1.1:
Fixed error in ascii output file that incorrectly gave the 
units for annual precipitation as cm/year - the real units are mm/yr.
*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
*/

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <time.h>
#include <math.h>
#include "ini.h"
#include "bgc_struct.h"
#include "pointbgc_struct.h"
#include "pointbgc_func.h"

int output_init(file init, output_struct* output)
{
	int ok = 1;
	int i;
	char key1[] = "OUTPUT_CONTROL";
	char key2[] = "DAILY_OUTPUT";
	char key3[] = "ANNUAL_OUTPUT";
	char keyword[80];

	/********************************************************************
	**                                                                 **
	** Begin reading initialization file block starting with keyword:  **
	** OUTPUT_CONTROL                                                  ** 
	**                                                                 **
	********************************************************************/
	
	/* scan for the output file block keyword, exit if not next */
	if (ok && scan_value(init, keyword, 's'))
	{
		printf("Error reading keyword for output file data\n");
		ok=0;
	}
	if (ok && strcmp(keyword, key1))
	{
		printf("Expecting keyword --> %s in file %s\n",key1,init.name);
		ok=0;
	}
	
	/* get the output filename prefix */
	if (ok && scan_value(init,output->outprefix,'s'))
	{
		printf("Error reading outfile prefix: output_init(), output_init.c\n");
		ok=0;
	}
	/* scan flags for daily output */
	if (ok && scan_value(init, &output->dodaily, 'i'))
	{
		printf("Error reading daily output flag: output_init()\n");
		ok=0;
	}
	/* scan flag for monthly average output (operates on daily variables) */
	if (ok && scan_value(init, &output->domonavg, 'i'))
	{
		printf("Error reading monthly average output flag: output_init()\n");
		ok=0;
	}
	/* scan flag for annual average output (operates on daily variables) */
	if (ok && scan_value(init, &output->doannavg, 'i'))
	{
		printf("Error reading annual average output flag: output_init()\n");
		ok=0;
	}
	/* scan flag for annual output */
	if (ok && scan_value(init, &output->doannual, 'i'))
	{
		printf("Error reading annual output flag: output_init()\n");
		ok=0;
	}
	/* scan flag for on-screen progress indicator */
	if (ok && scan_value(init, &output->onscreen, 'i'))
	{
		printf("Error reading on-screen indicator flag: output_init()\n");
		ok=0;
	}
	
	/* open outfiles if specified */
	if (ok && output->dodaily)
	{
		strcpy(output->dayout.name,output->outprefix);
		strcat(output->dayout.name,".dayout");
		if (file_open(&(output->dayout),'w'))
		{
			printf("Error opening daily outfile (%s) in output_init()\n",output->dayout.name);
			ok=0;
		}
	}
	if (ok && output->domonavg)
	{
		strcpy(output->monavgout.name,output->outprefix);
		strcat(output->monavgout.name,".monavgout");
		if (file_open(&(output->monavgout),'w'))
		{
			printf("Error opening monthly average outfile (%s) in output_init()\n",output->monavgout.name);
			ok=0;
		}
	}
	if (ok && output->doannavg)
	{
		strcpy(output->annavgout.name,output->outprefix);
		strcat(output->annavgout.name,".annavgout");
		if (file_open(&(output->annavgout),'w'))
		{
			printf("Error opening annual average outfile (%s) in output_init()\n",output->annavgout.name);
			ok=0;
		}
	}
	if (ok && output->doannual)
	{
		strcpy(output->annout.name,output->outprefix);
		strcat(output->annout.name,".annout");
		if (file_open(&(output->annout),'w'))
		{
			printf("Error opening annual outfile (%s) in output_init()\n",output->annout.name);
			ok=0;
		}
	}
	if (ok)
	{
		/* simple text output */
		strcpy(output->anntext.name,output->outprefix);
		strcat(output->anntext.name,"_ann.txt");
		if (file_open(&(output->anntext),'o'))
		{
			printf("Error opening annual text file (%s) in output_init()\n",output->anntext.name);
			ok=0;
		}
		/* write the header info for simple text file */
		fprintf(output->anntext.ptr,"Annual summary output from Biome-BGC version 4.1.2\n");
		fprintf(output->anntext.ptr,"ann PRCP = annual total precipitation (mm/yr)\n");
		fprintf(output->anntext.ptr,"ann Tavg = annual average air temperature (deg C)\n");
		fprintf(output->anntext.ptr,"max LAI = annual maximum value of projected leaf area index (m2/m2)\n");
		fprintf(output->anntext.ptr,"ann ET = annual total evapotranspiration (mm/yr)\n");
		fprintf(output->anntext.ptr,"ann OF = annual total outflow (mm/yr)\n");
		fprintf(output->anntext.ptr,"ann NPP = annual total net primary production (gC/m2/yr)\n");
		fprintf(output->anntext.ptr,"ann NPB = annual total net biome production (gC/m2/yr)\n\n");
		fprintf(output->anntext.ptr,"%6s%10s%10s%10s%10s%10s%10s%10s\n","year","ann PRCP","ann Tavg",
			"max LAI","ann ET","ann OF","ann NPP","ann NBP");

	}
	
	/********************************************************************
	**                                                                 **
	** Begin reading initialization file block starting with keyword:  **
	** DAILY_OUTPUT                                                    ** 
	**                                                                 **
	********************************************************************/
	
	/* scan for the output file block keyword, exit if not next */
	if (ok && scan_value(init, keyword, 's'))
	{
		printf("Error reading keyword for output file data\n");
		ok=0;
	}
	if (ok && strcmp(keyword, key2))
	{
		printf("Expecting keyword --> %s in file %s\n",key2,init.name);
		ok=0;
	}
	
	/* read the number of daily output variables */
	if (ok && scan_value(init, &output->ndayout, 'i'))
	{
		printf("Error reading number of daily outputs: output_init()\n");
		ok=0;
	}
	/* allocate space for the daily output variable indices */
	if (ok && output->ndayout && !(output->daycodes = (int*) malloc(output->ndayout * sizeof(int))))
	{
		printf("Error allocating for daycodes array: output_init()\n");
		ok=0;
	}
	/* begin loop to read in the daily output variable indices */
	for (i=0 ; ok && i<output->ndayout ; i++)
	{
		if (ok && scan_value(init, &(output->daycodes[i]), 'i'))
		{
			printf("Error reading daily output #%d: output_init()\n",i);
			ok=0;
		}
	}
	
	/********************************************************************
	**                                                                 **
	** Begin reading initialization file block starting with keyword:  **
	** ANNUAL_OUTPUT                                                   ** 
	**                                                                 **
	********************************************************************/
	
	/* scan for the output file block keyword, exit if not next */
	if (ok && scan_value(init, keyword, 's'))
	{
		printf("Error reading keyword for output file data\n");
		ok=0;
	}
	if (ok && strcmp(keyword, key3))
	{
		printf("Expecting keyword --> %s in file %s\n",key3,init.name);
		ok=0;
	}
	
	/* read the number of annual output variables */
	if (ok && scan_value(init, &output->nannout, 'i'))
	{
		printf("Error reading number of annual outputs: output_init()\n");
		ok=0;
	}
	/* allocate space for the annual output variable indices */
	if (ok && output->nannout && !(output->anncodes = (int*) malloc(output->nannout * sizeof(int))))
	{
		printf("Error allocating for anncodes array: output_init()\n");
		ok=0;
	}
	/* begin loop to read in the annual output variable indices */
	for (i=0 ; ok && i<output->nannout ; i++)
	{
		if (ok && scan_value(init, &(output->anncodes[i]), 'i'))
		{
			printf("Error reading annual output #%d: output_init()\n",i);
			ok=0;
		}
	}
	
	return (!ok);
}