applications/utilities/postProcessing/dataConversion/foamToTecplot360/tecio/tecsrc/DATAUTIL.h

   1 /*
   2  * NOTICE and LICENSE for Tecplot Input/Output Library (TecIO) - OpenFOAM
   3  *
   4  * Copyright (C) 1988-2009 Tecplot, Inc.  All rights reserved worldwide.
   5  *
   6  * Tecplot hereby grants OpenCFD limited authority to distribute without
   7  * alteration the source code to the Tecplot Input/Output library, known
   8  * as TecIO, as part of its distribution of OpenFOAM and the
   9  * OpenFOAM_to_Tecplot converter.  Users of this converter are also hereby
  10  * granted access to the TecIO source code, and may redistribute it for the
  11  * purpose of maintaining the converter.  However, no authority is granted
  12  * to alter the TecIO source code in any form or manner.
  13  *
  14  * This limited grant of distribution does not supersede Tecplot, Inc.'s
  15  * copyright in TecIO.  Contact Tecplot, Inc. for further information.
  16  *
  17  * Tecplot, Inc.
  18  * 3535 Factoria Blvd, Ste. 550
  19  * Bellevue, WA 98006, USA
  20  * Phone: +1 425 653 1200
  21  * http://www.tecplot.com/
  22  *
  23  */
  24 /*
  25  * DATAUTIL.h : COPYRIGHT (C)1987-2002 Tecplot, Inc.
  26  *                 ALL RIGHTS RESERVED
  27  *
  28  * NOTE:  THIS MODULE NOW IS PART OF THE TECPLOT SOURCE
  29  *        ONLY EDIT THIS IN THE MAIN TECPLOT SOURCE DIRECTORY.
  30  *
  31  *
  32  */
  33 #ifndef DATAUTIL_H
  34 #define DATAUTIL_H
  35 #define DATAUTIL_VERSION 61
  36
  37 #if defined MAKEARCHIVE
  38 extern void InitInputSpecs(void);
  39 #endif
  40
  41
  42 /*
  43  *
  44  * Read a binary tecplot datafile.
  45  *
  46  * @param GetHeaderInfoOnly
  47  *   Return only the header info from the datafile.
  48  *
  49  * @param FName
  50  *  Name of the file to read.
  51  *
  52  * @param IVersion
  53  *  Returns version of the input file.
  54  *
  55  * @param DataSetTitle
  56  *  Allocates space for and returns dataset title.
  57  *
  58  * @param NumZones
  59  *  Returns the number of zones.
  60  *
  61  * @param NumVars
  62  *  Returns the number of variables.
  63  *
  64  * @param VarNames
  65  *  Allocates space for and returns the var names.
  66  *
  67  * @param ZoneNames
  68  *  Allocates space for and returns the zone names.
  69  *
  70  * @param NumPtsI, NumPtsJ, NumPtsK
  71  *  Zone dimensions loaded into LgIndex_t arrays.
  72  *
  73  * @param ZoneNames
  74  *  Zone types loaded into ZoneType_e array.
  75  *
  76  * @param UserRec
  77  *  Allocates space for and returns the user records.
  78  *
  79  * @param RawDataspaceAllocated
  80  *  Only used if GetHeaderInfoOnly is FALSE. TRUE = calling program has alloced space for
  81  *  the raw data. FALSE= let ReadTec allocate space for the raw data.
  82  *
  83  * @param NodeMap
  84  *  Finite Element connectivity information. ReadTec
  85  *  will allocate the space for you if RawDataspaceAllocated is FALSE.
  86  *
  87  * @param VDataBase
  88  *  Raw field data loaded into double arrays.  ReadTec
  89  *  will allocate the space for you if RawDataspaceAllocated is
  90  *  FALSE.  If RawDataspaceAllocated is TRUE then ReadTec will
  91  *  only load the arrays that have non NULL addresses.
  92  *
  93  */
  94 LIBFUNCTION Boolean_t STDCALL ReadTec(Boolean_t       GetHeaderInfoOnly,
  95                                       char           *FName,
  96                                       short          *IVersion,
  97                                       char          **DataSetTitle,
  98                                       EntIndex_t     *NumZones,
  99                                       EntIndex_t     *NumVars,
 100                                       StringList_pa  *VarNames,
 101                                       StringList_pa  *ZoneNames,
 102                                       LgIndex_t     **NumPtsI,
 103                                       LgIndex_t     **NumPtsJ,
 104                                       LgIndex_t     **NumPtsK,
 105                                       ZoneType_e    **ZoneType,
 106                                       StringList_pa  *UserRec,
 107                                       Boolean_t       RawDataspaceAllocated,
 108                                       NodeMap_t    ***NodeMap,
 109                                       double       ***VDataBase);
 110
 111 LIBFUNCTION void * STDCALL TecAlloc(size_t size);
 112
 113 LIBFUNCTION void STDCALL TecFree(void *ptr);
 114
 115
 116 #endif /* !DATAUTIL_H */