epilectrik
/
pyNgSpice
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6219 Commits
1 Branch
0 Tags
36 MiB
 
 
 
 
 
 
Tree: d7089adcaf
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd7089adcaf'
${ noResults }
pyNgSpice/src/xspice/icm/table/table3D/cfunc.mod

803 lines
24 KiB
Raw Blame History

/*.......1.........2.........3.........4.........5.........6.........7.........8
================================================================================
FILE table3D/cfunc.mod
Copyright 2015
Holger Vogt
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
AUTHORS
03 Nov 2015 Holger Vogt
MODIFICATIONS
10 Aug 2018 Holger Vogt
SUMMARY
This file contains the model-specific routines used to
functionally describe the 3D table code model used
to read and interpolate a value from a 3D table from a file.
The essentially non-oscillatory (ENO) interpolation in 3-D (eno3.c) is taken from the
Madagascar Project at http://www.ahay.org/wiki/Main_Page
Currently ENO is used only to obtain the derivatives,
the data values are obtained by trilinear interpolation.
This combination allows op convergence for some data tables (no guarantee though).
INTERFACES
FILE ROUTINE CALLED
N/A N/A
REFERENCED FILES
Inputs from and outputs to ARGS structure.
NON-STANDARD FEATURES
NONE
===============================================================================*/
/*=== INCLUDE FILES ====================*/
#include <stdio.h>
#include <ctype.h>
#include <stdlib.h>
#include <string.h>
#include <math.h>
#include <sys/types.h>
#include <sys/stat.h>
#include "mada/eno2.h"
#include "mada/eno3.h"
/*=== CONSTANTS ========================*/
#define OK 0
#define FAIL 1
/*=== MACROS ===========================*/
#if defined(__MINGW32__) || defined(_MSC_VER)
#define DIR_PATHSEP "\\"
#else
#define DIR_PATHSEP "/"
#endif
#if defined(_MSC_VER)
#define strdup _strdup
#define snprintf _snprintf
#endif
/*=== LOCAL VARIABLES & TYPEDEFS =======*/
struct filesource_state {
FILE *fp;
long pos;
unsigned char atend;
};
typedef struct {
int ix; /* size of array in x */
int iy; /* size of array in y */
int iz; /* size of array in z */
struct filesource_state *state; /* the storage array for the
filesource status. */
int init_err;
sf_eno3 newtable; /* the table, code borrowed from madagascar project */
double *xcol; /* array of doubles in x */
double *ycol; /* array of doubles in y */
double *zcol; /* array of doubles in z */
double ***table;
} Local_Data_t;
/*********************/
/* 3d geometry types */
/*********************/
typedef char line_t[82]; /* A SPICE size line. <= 80 characters plus '\n\0' */
/*=== FUNCTION PROTOTYPE DEFINITIONS ===*/
extern int findCrossOver(double arr[], int low, int high, double x);
extern double TrilinearInterpolation(double x, double y, double z, int xind, int yind, int zind, double ***td);
extern char *CNVgettok(char **s);
/*==============================================================================
FUNCTION cnv_get_spice_value()
AUTHORS
??? Bill Kuhn
MODIFICATIONS
30 Sep 1991 Jeffrey P. Murray
SUMMARY
This function takes as input a string token from a SPICE
deck and returns a floating point equivalent value.
INTERFACES
FILE ROUTINE CALLED
N/A N/A
RETURNED VALUE
Returns the floating point value in pointer *p_value. Also
returns an integer representing successful completion.
GLOBAL VARIABLES
NONE
NON-STANDARD FEATURES
NONE
==============================================================================*/
/*=== Static CNV_get_spice_value ROUTINE =============*/
/*
Function takes as input a string token from a SPICE
deck and returns a floating point equivalent value.
*/
static int
cnv_get_spice_value(char *str, /* IN - The value text e.g. 1.2K */
double *p_value) /* OUT - The numerical value */
{
/* the following were "int4" devices - jpm */
size_t len;
size_t i;
int n_matched;
line_t val_str;
char c = ' ';
char c1;
double scale_factor;
double value;
/* Scan the input string looking for an alpha character that is not */
/* 'e' or 'E'. Such a character is assumed to be an engineering */
/* suffix as defined in the Spice 2G.6 user's manual. */
len = strlen(str);
if (len > sizeof(val_str) - 1)
len = sizeof(val_str) - 1;
for (i = 0; i < len; i++) {
c = str[i];
if (isalpha_c(c) && (c != 'E') && (c != 'e'))
break;
else if (isspace_c(c))
break;
else
val_str[i] = c;
}
val_str[i] = '\0';
/* Determine the scale factor */
if ((i >= len) || (! isalpha_c(c)))
scale_factor = 1.0;
else {
if (isupper_c(c))
c = tolower_c(c);
switch (c) {
case 't':
scale_factor = 1.0e12;
break;
case 'g':
scale_factor = 1.0e9;
break;
case 'k':
scale_factor = 1.0e3;
break;
case 'u':
scale_factor = 1.0e-6;
break;
case 'n':
scale_factor = 1.0e-9;
break;
case 'p':
scale_factor = 1.0e-12;
break;
case 'f':
scale_factor = 1.0e-15;
break;
case 'm':
i++;
if (i >= len) {
scale_factor = 1.0e-3;
break;
}
c1 = str[i];
if (!isalpha_c(c1)) {
scale_factor = 1.0e-3;
break;
}
if (islower_c(c1))
c1 = toupper_c(c1);
if (c1 == 'E')
scale_factor = 1.0e6;
else if (c1 == 'I')
scale_factor = 25.4e-6;
else
scale_factor = 1.0e-3;
break;
default:
scale_factor = 1.0;
}
}
/* Convert the numeric portion to a float and multiply by the */
/* scale factor. */
n_matched = sscanf(val_str, "%le", &value);
if (n_matched < 1) {
*p_value = 0.0;
return FAIL;
}
*p_value = value * scale_factor;
return OK;
}
static void
cm_table3D_callback(ARGS, Mif_Callback_Reason_t reason)
{
switch (reason) {
case MIF_CB_DESTROY: {
int i, j;
Local_Data_t *loc = STATIC_VAR (locdata);
free(loc->state);
for (i = 0; i < loc->iz; i++) {
for (j = 0; j < loc->iy; j++)
free(loc->table[i][j]);
free(loc->table[i]);
}
free(loc->table);
free(loc->xcol);
free(loc->ycol);
free(loc->zcol);
sf_eno3_close (loc->newtable);
free(loc);
break;
}
}
}
/*==============================================================================
FUNCTION void cm_table3D()
AUTHORS
08 Nov 2015 Holger Vogt
MODIFICATIONS
SUMMARY
This function implements 3D table code model.
INTERFACES
FILE ROUTINE CALLED
N/A N/A
RETURNED VALUE
Returns inputs and outputs via ARGS structure.
GLOBAL VARIABLES
NONE
NON-STANDARD FEATURES
NONE
INPUT FILE SPEC
* Title (comments preceded by * ignored)
* table size
ix
iy
* x row independent variables
x0 x1 x2 x3 ... xix-1
y column independent variables
y0 y1 y2 y3 ... yiy-1
* table
x0y0 x1y0 x2y0 ... xix-1y0
...
x0yiy-1 x1yiy-1 x2yiy-1 ... xix-1yiy-1
==============================================================================*/
/*=== CM_table3D ROUTINE ===*/
void
cm_table3D(ARGS) /* structure holding parms, inputs, outputs, etc. */
{
int size, xind, yind, zind;
double xval, yval, zval, xoff, yoff, zoff, xdiff, ydiff, zdiff;
double derivval[3], outval;
Local_Data_t *loc; /* Pointer to local static data, not to be included
in the state vector */
Mif_Complex_t ac_gain;
size = PORT_SIZE(out);
if (INIT == 1) {
int i, j;
int ix = 0, /* elements in a row */
iy = 0, /* number of rows */
iz = 0; /* number of 2D tables */
double ***table_data;
double tmp;
char *cFile, *cThisPtr, *cThisLine, *cThisLinePtr;
int isNewline; /* Boolean indicating we've read a CR or LF */
size_t lFileLen; /* Length of file */
size_t lFileRead; /* Length of file read in */
long lIndex; /* Index into cThisLine array */
int lLineCount; /* Current line number */
size_t lStartPos; /* Offset of start of current line */
size_t lTotalChars; /* Total characters read */
int lTableCount; /* Number of tables */
int interporder; /* order of interpolation for eno */
CALLBACK = cm_table3D_callback;
/* allocate static storage for *loc */
STATIC_VAR (locdata) = calloc (1, sizeof(Local_Data_t));
loc = STATIC_VAR (locdata);
/* Allocate storage for internal state */
loc->state = (struct filesource_state*) malloc(sizeof(struct filesource_state));
loc->ix = loc->iy = loc->iz = 0;
loc->init_err = 0;
/* open file */
loc->state->fp = fopen_with_path(PARAM(file), "r");
loc->state->pos = 0;
loc->state->atend = 0;
if (!loc->state->fp) {
char *lbuffer, *pp;
lbuffer = getenv("NGSPICE_INPUT_DIR");
if (lbuffer && *lbuffer) {
pp = (char*) malloc(strlen(lbuffer) + strlen(DIR_PATHSEP) + strlen(PARAM(file)) + 1);
sprintf(pp, "%s%s%s", lbuffer, DIR_PATHSEP, PARAM(file));
loc->state->fp = fopen(pp, "r");
free(pp);
}
}
struct stat st;
if (!loc->state->fp || fstat(fileno(loc->state->fp), &st)) {
cm_message_printf("cannot open file %s", PARAM(file));
loc->state->atend = 1;
loc->init_err = 1;
return;
}
/* get file length */
lFileLen = (size_t) st.st_size;
/* create string to hold the whole file */
cFile = calloc(lFileLen + 1, sizeof(char));
/* create another string long enough for file manipulation */
cThisLine = calloc(lFileLen + 1, sizeof(char));
if (cFile == NULL || cThisLine == NULL) {
cm_message_printf("Insufficient memory to read file %s", PARAM(file));
loc->state->atend = 1;
loc->init_err = 1;
if(cFile) free(cFile);
if(cThisLine) free(cThisLine);
return;
}
/* read whole file into cFile */
lFileRead = fread(cFile, sizeof(char), lFileLen, loc->state->fp);
fclose(loc->state->fp);
/* Number of chars read may be less than lFileLen, because /r are skipt by 'fread' */
cFile[lFileRead] = '\0';
cThisPtr = cFile;
cThisLinePtr = cThisLine;
lLineCount = 0L;
lTotalChars = 0L;
while (*cThisPtr) { /* Read until reaching null char */
lIndex = 0L; /* Reset counters and flags */
isNewline = 0;
lStartPos = lTotalChars;
while (*cThisPtr) { /* Read until reaching null char */
if (!isNewline) { /* Haven't read a LF yet */
if (*cThisPtr == '\n') /* This char is a LF */
isNewline = 1; /* Set flag */
}
else if (*cThisPtr != '\n') /* Already found LF */
break; /* Done with line */
cThisLinePtr[lIndex++] = *cThisPtr++; /* Add char to output and increment */
lTotalChars++;
}
cThisLinePtr[lIndex] = '\0'; /* Terminate the string */
lLineCount++; /* Increment the line counter */
/* continue if comment or empty */
if (cThisLinePtr[0] == '*' || cThisLinePtr[0] == '\n') {
lLineCount--; /* we count only real lines */
continue;
}
if (lLineCount == 1) {
cnv_get_spice_value(cThisLinePtr, &tmp);
loc->ix = ix = (int) tmp;
/* generate row data structure (x) */
loc->xcol = (double*) calloc((size_t) ix, sizeof(double));
} else if (lLineCount == 2) {
cnv_get_spice_value(cThisLinePtr, &tmp);
loc->iy = iy = (int) tmp;
/* generate column data structure (y) */
loc->ycol = (double*) calloc((size_t) iy, sizeof(double));
} else if (lLineCount == 3) {
cnv_get_spice_value(cThisLinePtr, &tmp);
loc->iz = iz = (int) tmp;
/* generate column data structure (y) */
loc->zcol = (double*) calloc((size_t) iz, sizeof(double));
} else if (lLineCount == 4) {
char *token = CNVgettok(&cThisLinePtr);
i = 0;
while (token) {
if (i == ix) {
cm_message_printf("Too many numbers in x row.");
loc->init_err = 1;
return;
}
cnv_get_spice_value(token, &loc->xcol[i++]);
free(token);
token = CNVgettok(&cThisLinePtr);
}
if (i < ix) {
cm_message_printf("Not enough numbers in x row.");
loc->init_err = 1;
return;
}
} else if (lLineCount == 5) {
char *token = CNVgettok(&cThisLinePtr);
i = 0;
while (token) {
if (i == iy) {
cm_message_printf("Too many numbers in y row.");
loc->init_err = 1;
return;
}
cnv_get_spice_value(token, &loc->ycol[i++]);
free(token);
token = CNVgettok(&cThisLinePtr);
}
if (i < iy) {
cm_message_printf("Not enough numbers in y row.");
loc->init_err = 1;
return;
}
} else if (lLineCount == 6) {
char *token = CNVgettok(&cThisLinePtr);
i = 0;
while (token) {
if (i == iz) {
cm_message_printf("Too many numbers in z row.");
loc->init_err = 1;
return;
}
cnv_get_spice_value(token, &loc->zcol[i++]);
free(token);
token = CNVgettok(&cThisLinePtr);
}
if (i < iz) {
cm_message_printf("Not enough numbers in z row.");
loc->init_err = 1;
return;
}
/* jump out of while loop to read in the table */
break;
}
}
/* generate table core */
interporder = PARAM(order);
/* boundary limits set to param 'order' aren't recognized,
so limit them here */
if (interporder < 2) {
cm_message_printf("Parameter Order=%d not possible, set to minimum value 2", interporder);
interporder = 2;
}
/* int order : interpolation order,
int n1, int n2, int n3 : data dimensions */
loc->newtable = sf_eno3_init(interporder, ix, iy, iz);
/* create table_data in memory */
/* data [n3][n2][n1] */
table_data = calloc((size_t) iy, sizeof(double *));
for (i = 0; i < iz; i++) {
table_data[i] = calloc((size_t) iy, sizeof(double *));
for (j = 0; j < iy; j++)
table_data[i][j] = calloc((size_t) ix, sizeof(double));
}
loc->table = table_data;
/* continue reading from cFile */
for (lTableCount = 0; lTableCount < iz; lTableCount++) {
lLineCount = 0;
while (lLineCount < iy) {
char *token;
lIndex = 0L; /* Reset counters and flags */
isNewline = 0;
lStartPos = lTotalChars;
/* read a line */
while (*cThisPtr) { /* Read until reaching null char */
if (!isNewline) { /* Haven't read a CR or LF yet */
if (*cThisPtr == '\n') /* This char is LF */
isNewline = 1; /* Set flag */
}
else if (*cThisPtr != '\n') /* Already found LF */
break; /* Done with line */
cThisLinePtr[lIndex++] = *cThisPtr++; /* Add char to output and increment */
lTotalChars++;
}
cThisLinePtr[lIndex] = '\0'; /* Terminate the string */
/* continue if comment or empty */
if (cThisLinePtr[0] == '*' || cThisLinePtr[0] == '\0') {
if (lTotalChars >= lFileLen) {
cm_message_printf("Not enough data in file %s", PARAM(file));
loc->init_err = 1;
return;
}
continue;
}
token = CNVgettok(&cThisLinePtr);
i = 0;
while (token) {
double tmpval;
if (i == ix) {
cm_message_printf("Too many numbers in y row no. %d of table %d.", lLineCount, lTableCount);
loc->init_err = 1;
return;
}
/* read table core from cFile, fill local static table structure table_data */
cnv_get_spice_value(token, &tmpval);
table_data[lTableCount][lLineCount][i++] = tmpval;
free(token);
token = CNVgettok(&cThisLinePtr);
}
if (i < ix) {
cm_message_printf("Not enough numbers in y row no. %d of table %d.", lLineCount, lTableCount);
loc->init_err = 1;
return;
}
lLineCount++;
}
}
/* fill table data into eno3 structure */
sf_eno3_set(loc->newtable, table_data /* data [n3][n2][n1] */);
/* free file memory allocated */
free(cFile);
free(cThisLine);
} /* end of initialization "if (INIT == 1)" */
loc = STATIC_VAR (locdata);
/* return immediately if there was an initialization error */
if (loc->init_err == 1)
return;
/* get input x, y, z;
find corresponding indices;
get x and y offsets;
call interpolation functions with value and derivative */
xval = INPUT(inx);
yval = INPUT(iny);
zval = INPUT(inz);
/* check table ranges */
if (xval < loc->xcol[0] || xval > loc->xcol[loc->ix - 1]) {
if (PARAM(verbose) > 0)
cm_message_printf("x value %g exceeds table limits, \nplease enlarge range of your table", xval);
return;
}
if (yval < loc->ycol[0] || yval > loc->ycol[loc->iy - 1]) {
if (PARAM(verbose) > 0)
cm_message_printf("y value %g exceeds table limits, \nplease enlarge range of your table", yval);
return;
}
if (zval < loc->zcol[0] || zval > loc->zcol[loc->iz - 1]) {
if (PARAM(verbose) > 0)
cm_message_printf("z value %g exceeds table limits, \nplease enlarge range of your table", zval);
return;
}
/* find index */
/* something like binary search to get the index */
xind = findCrossOver(loc->xcol, 0, loc->ix - 1, xval);
/* find index with minimum distance between xval and row value
if (fabs(loc->xcol[xind + 1] - xval) < fabs(xval - loc->xcol[xind]))
xind++;
*/
xoff = xval - loc->xcol[xind];
yind = findCrossOver(loc->ycol, 0, loc->iy - 1, yval);
/* find index with minimum distance between yval and column value
if (fabs(loc->ycol[yind + 1] - yval) < fabs(yval - loc->ycol[yind]))
yind++;
*/
yoff = yval - loc->ycol[yind];
zind = findCrossOver(loc->zcol, 0, loc->iz - 1, zval);
/* find index with minimum distance between zval and table value
if (fabs(loc->zcol[zind + 1] - zval) < fabs(zval - loc->zcol[zind]))
zind++;
*/
zoff = zval - loc->zcol[zind];
/* find local difference around index of independent row and column values */
if (xind == loc->ix - 1)
xdiff = loc->xcol[xind] - loc->xcol[xind - 1];
else if (xind == 0)
xdiff = loc->xcol[xind + 1] - loc->xcol[xind];
else
xdiff = 0.5 * (loc->xcol[xind + 1] - loc->xcol[xind - 1]);
if (yind == loc->iy - 1)
ydiff = loc->ycol[yind] - loc->ycol[yind - 1];
else if (yind == 0)
ydiff = loc->ycol[yind + 1] - loc->ycol[yind];
else
ydiff = 0.5 * (loc->ycol[yind + 1] - loc->ycol[yind - 1]);
if (zind == loc->iz - 1)
zdiff = loc->zcol[zind] - loc->zcol[zind - 1];
else if (zind == 0)
zdiff = loc->zcol[zind + 1] - loc->zcol[zind];
else
zdiff = 0.5 * (loc->zcol[zind + 1] - loc->zcol[zind - 1]);
/* Essentially non-oscillatory (ENO) interpolation to obtain the derivatives only.
Using outval for now yields ngspice op non-convergence */
sf_eno3_apply (loc->newtable,
xind, yind, zind, /* grid location */
xoff, yoff, zoff, /* offset from grid */
&outval, /* output data value */
derivval, /* output derivatives [3] */
DER /* what to compute [FUNC, DER, BOTH] */
);
/* xind yind zind may become too large */
if (xind == loc->ix - 1)
xind--;
if (yind == loc->iy - 1)
yind--;
if (zind == loc->iz - 1)
zind--;
/* overwrite outval from sf_eno3_apply by trilinear interpolation */
outval = TrilinearInterpolation(xoff / (loc->xcol[xind + 1] - loc->xcol[xind]),
yoff / (loc->ycol[yind + 1] - loc->ycol[yind]),
zoff / (loc->zcol[zind + 1] - loc->zcol[zind]),
xind, yind, zind, loc->table);
if (ANALYSIS != MIF_AC) {
double xderiv, yderiv, zderiv, outv;
outv = PARAM(offset) + PARAM(gain) * outval;
OUTPUT(out) = outv;
xderiv = PARAM(gain) * derivval[0] / xdiff;
PARTIAL(out, inx) = xderiv;
yderiv = PARAM(gain) * derivval[1] / ydiff;
PARTIAL(out, iny) = yderiv;
zderiv = PARAM(gain) * derivval[2] / zdiff;
PARTIAL(out, inz) = zderiv;
if (PARAM(verbose) > 1)
cm_message_printf("\nI: %g, xval: %g, yval: %g, zval: %g, xderiv: %g, yderiv: %g, zderiv: %g", outv, xval, yval, zval, xderiv, yderiv, zderiv);
} else {
ac_gain.real = PARAM(gain) * derivval[0] / xdiff;
ac_gain.imag= 0.0;
AC_GAIN(out, inx) = ac_gain;
ac_gain.real = PARAM(gain) * derivval[1] / ydiff;
ac_gain.imag= 0.0;
AC_GAIN(out, iny) = ac_gain;
}
}
/* These includes add functions from extra source code files,
* still using the standard XSPICE procedure of cmpp-ing cfunc.mod
* and then only compiling the resulting *.c file.
*/
#include "../support/gettokens.c" /* reading tokens */
#include "../support/interp.c" /* 2D and 3D linear interpolation */
#include "../mada/alloc.c" /* eno interpolation from madagascar project */
#include "../mada/eno.c" /* eno interpolation from madagascar project */
#include "../mada/eno2.c" /* eno interpolation from madagascar project */
#include "../mada/eno3.c" /* eno interpolation from madagascar project */