ref: 4cb315f58a570ac0f640c6ea135b70fcbbf1f32f
dir: /LEAF/Src/leaf-electrical.c/
/*
* leaf-electrical.c
*
* Created on: Sep 25, 2019
* Author: jeffsnyder
*/
#if _WIN32 || _WIN64
#include "..\Inc\leaf-electrical.h"
#include "..\leaf.h"
#else
#include "../Inc/leaf-electrical.h"
#include "../leaf.h"
#endif
//==============================================================================
static float get_port_resistance_for_resistor(tWDF* const r);
static float get_port_resistance_for_capacitor(tWDF* const r);
static float get_port_resistance_for_inductor(tWDF* const r);
static float get_port_resistance_for_resistive(tWDF* const r);
static float get_port_resistance_for_inverter(tWDF* const r);
static float get_port_resistance_for_series(tWDF* const r);
static float get_port_resistance_for_parallel(tWDF* const r);
static float get_port_resistance_for_root(tWDF* const r);
static void set_incident_wave_for_leaf(tWDF* const r, float incident_wave, float input);
static void set_incident_wave_for_leaf_inverted(tWDF* const r, float incident_wave, float input);
static void set_incident_wave_for_inverter(tWDF* const r, float incident_wave, float input);
static void set_incident_wave_for_series(tWDF* const r, float incident_wave, float input);
static void set_incident_wave_for_parallel(tWDF* const r, float incident_wave, float input);
static float get_reflected_wave_for_resistor(tWDF* const r, float input);
static float get_reflected_wave_for_capacitor(tWDF* const r, float input);
static float get_reflected_wave_for_resistive(tWDF* const r, float input);
static float get_reflected_wave_for_inverter(tWDF* const r, float input);
static float get_reflected_wave_for_series(tWDF* const r, float input);
static float get_reflected_wave_for_parallel(tWDF* const r, float input);
static float get_reflected_wave_for_ideal(tWDF* const n, float input, float incident_wave);
static float get_reflected_wave_for_diode(tWDF* const n, float input, float incident_wave);
static float get_reflected_wave_for_diode_pair(tWDF* const n, float input, float incident_wave);
static void wdf_init(tWDF* const wdf, WDFComponentType type, float value, tWDF* const rL, tWDF* const rR)
{
_tWDF* r = *wdf;
r->type = type;
r->child_left = rL;
r->child_right = rR;
r->incident_wave_up = 0.0f;
r->incident_wave_left = 0.0f;
r->incident_wave_right = 0.0f;
r->reflected_wave_up = 0.0f;
r->reflected_wave_left = 0.0f;
r->reflected_wave_right = 0.0f;
r->sample_rate = leaf.sampleRate;
r->value = value;
tWDF* child;
if (r->child_left != NULL) child = r->child_left;
else child = r->child_right;
if (r->type == Resistor)
{
r->port_resistance_up = r->value;
r->port_conductance_up = 1.0f / r->value;
r->get_port_resistance = &get_port_resistance_for_resistor;
r->get_reflected_wave_up = &get_reflected_wave_for_resistor;
r->set_incident_wave = &set_incident_wave_for_leaf;
}
else if (r->type == Capacitor)
{
r->port_conductance_up = r->sample_rate * 2.0f * r->value;
r->port_resistance_up = 1.0f / r->port_conductance_up; //based on trapezoidal discretization
r->get_port_resistance = &get_port_resistance_for_capacitor;
r->get_reflected_wave_up = &get_reflected_wave_for_capacitor;
r->set_incident_wave = &set_incident_wave_for_leaf;
}
else if (r->type == Inductor)
{
r->port_resistance_up = r->sample_rate * 2.0f * r->value; //based on trapezoidal discretization
r->port_conductance_up = 1.0f / r->port_resistance_up;
r->get_port_resistance = &get_port_resistance_for_inductor;
r->get_reflected_wave_up = &get_reflected_wave_for_capacitor; // same as capacitor
r->set_incident_wave = &set_incident_wave_for_leaf_inverted;
}
else if (r->type == ResistiveSource)
{
r->port_resistance_up = r->value;
r->port_conductance_up = 1.0f / r->port_resistance_up;
r->get_port_resistance = &get_port_resistance_for_resistive;
r->get_reflected_wave_up = &get_reflected_wave_for_resistive;
r->set_incident_wave = &set_incident_wave_for_leaf;
}
else if (r->type == Inverter)
{
r->port_resistance_up = tWDF_getPortResistance(r->child_left);
r->port_conductance_up = 1.0f / r->port_resistance_up;
r->get_port_resistance = &get_port_resistance_for_inverter;
r->get_reflected_wave_up = &get_reflected_wave_for_inverter;
r->set_incident_wave = &set_incident_wave_for_inverter;
}
else if (r->type == SeriesAdaptor)
{
r->port_resistance_left = tWDF_getPortResistance(r->child_left);
r->port_resistance_right = tWDF_getPortResistance(r->child_right);
r->port_resistance_up = r->port_resistance_left + r->port_resistance_right;
r->port_conductance_up = 1.0f / r->port_resistance_up;
r->port_conductance_left = 1.0f / r->port_resistance_left;
r->port_conductance_right = 1.0f / r->port_resistance_right;
r->gamma_zero = 1.0f / (r->port_resistance_right + r->port_resistance_left);
r->get_port_resistance = &get_port_resistance_for_series;
r->get_reflected_wave_up = &get_reflected_wave_for_series;
r->set_incident_wave = &set_incident_wave_for_series;
}
else if (r->type == ParallelAdaptor)
{
r->port_resistance_left = tWDF_getPortResistance(r->child_left);
r->port_resistance_right = tWDF_getPortResistance(r->child_right);
r->port_resistance_up = (r->port_resistance_left * r->port_resistance_right) / (r->port_resistance_left + r->port_resistance_right);
r->port_conductance_up = 1.0f / r->port_resistance_up;
r->port_conductance_left = 1.0f / r->port_resistance_left;
r->port_conductance_right = 1.0f / r->port_resistance_right;
r->gamma_zero = 1.0f / (r->port_resistance_right + r->port_resistance_left);
r->get_port_resistance = &get_port_resistance_for_parallel;
r->get_reflected_wave_up = &get_reflected_wave_for_parallel;
r->set_incident_wave = &set_incident_wave_for_parallel;
}
else if (r->type == IdealSource)
{
r->port_resistance_up = tWDF_getPortResistance(child);
r->port_conductance_up = 1.0f / r->port_resistance_up;
r->get_reflected_wave_down = &get_reflected_wave_for_ideal;
r->get_port_resistance = &get_port_resistance_for_root;
}
else if (r->type == Diode)
{
r->port_resistance_up = tWDF_getPortResistance(child);
r->port_conductance_up = 1.0f / r->port_resistance_up;
r->get_reflected_wave_down = &get_reflected_wave_for_diode;
r->get_port_resistance = &get_port_resistance_for_root;
}
else if (r->type == DiodePair)
{
r->port_resistance_up = tWDF_getPortResistance(child);
r->port_conductance_up = 1.0f / r->port_resistance_up;
r->get_reflected_wave_down = &get_reflected_wave_for_diode_pair;
r->get_port_resistance = &get_port_resistance_for_root;
}
}
//WDF
void tWDF_init(tWDF* const wdf, WDFComponentType type, float value, tWDF* const rL, tWDF* const rR)
{
*wdf = (_tWDF*) leaf_alloc(sizeof(_tWDF));
wdf_init(wdf, type, value, rL, rR);
}
void tWDF_free(tWDF* const wdf)
{
_tWDF* r = *wdf;
leaf_free(r);
}
void tWDF_initToPool (tWDF* const wdf, WDFComponentType type, float value, tWDF* const rL, tWDF* const rR, tMempool* const mp)
{
_tMempool* m = *mp;
*wdf = (_tWDF*) mpool_alloc(sizeof(_tWDF), m);
wdf_init(wdf, type, value, rL, rR);
}
void tWDF_freeFromPool (tWDF* const wdf, tMempool* const mp)
{
_tMempool* m = *mp;
_tWDF* r = *wdf;
mpool_free(r, m);
}
float tWDF_tick(tWDF* const wdf, float sample, tWDF* const outputPoint, uint8_t paramsChanged)
{
_tWDF* r = *wdf;
tWDF* child;
if (r->child_left != NULL) child = r->child_left;
else child = r->child_right;
//step 0 : update port resistances if something changed
if (paramsChanged) tWDF_getPortResistance(wdf);
//step 1 : set inputs to what they should be
float input = sample;
//step 2 : scan the waves up the tree
r->incident_wave_up = tWDF_getReflectedWaveUp(child, input);
//step 3 : do root scattering computation
r->reflected_wave_up = tWDF_getReflectedWaveDown(wdf, input, r->incident_wave_up);
//step 4 : propogate waves down the tree
tWDF_setIncidentWave(child, r->reflected_wave_up, input);
//step 5 : grab whatever voltages or currents we want as outputs
return tWDF_getVoltage(outputPoint);
}
void tWDF_setValue(tWDF* const wdf, float value)
{
_tWDF* r = *wdf;
r->value = value;
}
void tWDF_setSampleRate(tWDF* const wdf, float sample_rate)
{
_tWDF* r = *wdf;
r->sample_rate = sample_rate;
}
uint8_t tWDF_isLeaf(tWDF* const wdf)
{
_tWDF* r = *wdf;
if (r->child_left == NULL && r->child_right == NULL) return 1;
return 0;
}
float tWDF_getPortResistance(tWDF* const wdf)
{
_tWDF* r = *wdf;
return r->get_port_resistance(wdf);
}
void tWDF_setIncidentWave(tWDF* const wdf, float incident_wave, float input)
{
_tWDF* r = *wdf;
r->set_incident_wave(wdf, incident_wave, input);
}
float tWDF_getReflectedWaveUp(tWDF* const wdf, float input)
{
_tWDF* r = *wdf;
return r->get_reflected_wave_up(wdf, input);
}
float tWDF_getReflectedWaveDown(tWDF* const wdf, float input, float incident_wave)
{
_tWDF* r = *wdf;
return r->get_reflected_wave_down(wdf, input, incident_wave);
}
float tWDF_getVoltage(tWDF* const wdf)
{
_tWDF* r = *wdf;
return ((r->incident_wave_up * 0.5f) + (r->reflected_wave_up * 0.5f));
}
float tWDF_getCurrent(tWDF* const wdf)
{
_tWDF* r = *wdf;
return (((r->incident_wave_up * 0.5f) - (r->reflected_wave_up * 0.5f)) * r->port_conductance_up);
}
//============ Static Functions to be Pointed To ====================
//===================================================================
//============ Get and Calculate Port Resistances ===================
static float get_port_resistance_for_resistor(tWDF* const wdf)
{
_tWDF* r = *wdf;
r->port_resistance_up = r->value;
r->port_conductance_up = 1.0f / r->value;
return r->port_resistance_up;
}
static float get_port_resistance_for_capacitor(tWDF* const wdf)
{
_tWDF* r = *wdf;
r->port_conductance_up = r->sample_rate * 2.0f * r->value; //based on trapezoidal discretization
r->port_resistance_up = (1.0f / r->port_conductance_up);
return r->port_resistance_up;
}
static float get_port_resistance_for_inductor(tWDF* const wdf)
{
_tWDF* r = *wdf;
r->port_resistance_up = r->sample_rate * 2.0f * r->value; //based on trapezoidal discretization
r->port_conductance_up = (1.0f / r->port_resistance_up);
return r->port_resistance_up;
}
static float get_port_resistance_for_resistive(tWDF* const wdf)
{
_tWDF* r = *wdf;
r->port_resistance_up = r->value;
r->port_conductance_up = 1.0f / r->port_resistance_up;
return r->port_resistance_up;
}
static float get_port_resistance_for_inverter(tWDF* const wdf)
{
_tWDF* r = *wdf;
r->port_resistance_up = tWDF_getPortResistance(r->child_left);
r->port_conductance_up = 1.0f / r->port_resistance_up;
return r->port_resistance_up;
}
static float get_port_resistance_for_series(tWDF* const wdf)
{
_tWDF* r = *wdf;
r->port_resistance_left = tWDF_getPortResistance(r->child_left);
r->port_resistance_right = tWDF_getPortResistance(r->child_right);
r->port_resistance_up = r->port_resistance_left + r->port_resistance_right;
r->port_conductance_up = 1.0f / r->port_resistance_up;
r->port_conductance_left = 1.0f / r->port_resistance_left;
r->port_conductance_right = 1.0f / r->port_resistance_right;
r->gamma_zero = 1.0f / (r->port_resistance_right + r->port_resistance_left);
return r->port_resistance_up;
}
static float get_port_resistance_for_parallel(tWDF* const wdf)
{
_tWDF* r = *wdf;
r->port_resistance_left = tWDF_getPortResistance(r->child_left);
r->port_resistance_right = tWDF_getPortResistance(r->child_right);
r->port_resistance_up = (r->port_resistance_left * r->port_resistance_right) / (r->port_resistance_left + r->port_resistance_right);
r->port_conductance_up = 1.0f / r->port_resistance_up;
r->port_conductance_left = 1.0f / r->port_resistance_left;
r->port_conductance_right = 1.0f / r->port_resistance_right;
r->gamma_zero = 1.0f / (r->port_conductance_right + r->port_conductance_left);
return r->port_resistance_up;
}
static float get_port_resistance_for_root(tWDF* const wdf)
{
_tWDF* r = *wdf;
tWDF* child;
if (r->child_left != NULL) child = r->child_left;
else child = r->child_right;
r->port_resistance_up = tWDF_getPortResistance(child);
r->port_conductance_up = 1.0f / r->port_resistance_up;
return r->port_resistance_up;
}
//===================================================================
//================ Set Incident Waves ===============================
static void set_incident_wave_for_leaf(tWDF* const wdf, float incident_wave, float input)
{
_tWDF* r = *wdf;
r->incident_wave_up = incident_wave;
}
static void set_incident_wave_for_leaf_inverted(tWDF* const wdf, float incident_wave, float input)
{
_tWDF* r = *wdf;
r->incident_wave_up = -1.0f * incident_wave;
}
static void set_incident_wave_for_inverter(tWDF* const wdf, float incident_wave, float input)
{
_tWDF* r = *wdf;
r->incident_wave_up = incident_wave;
tWDF_setIncidentWave(r->child_left, -1.0f * incident_wave, input);
}
static void set_incident_wave_for_series(tWDF* const wdf, float incident_wave, float input)
{
_tWDF* r = *wdf;
r->incident_wave_up = incident_wave;
float gamma_left = r->port_resistance_left * r->gamma_zero;
float gamma_right = r->port_resistance_right * r->gamma_zero;
float left_wave = tWDF_getReflectedWaveUp(r->child_left, input);
float right_wave = tWDF_getReflectedWaveUp(r->child_right, input);
// downPorts[0]->b = yl * ( downPorts[0]->a * ((1.0 / yl) - 1) - downPorts[1]->a - descendingWave );
// downPorts[1]->b = yr * ( downPorts[1]->a * ((1.0 / yr) - 1) - downPorts[0]->a - descendingWave );
tWDF_setIncidentWave(r->child_left, (-1.0f * gamma_left * incident_wave) + (gamma_right * left_wave) - (gamma_left * right_wave), input);
tWDF_setIncidentWave(r->child_right, (-1.0f * gamma_right * incident_wave) + (gamma_left * right_wave) - (gamma_right * left_wave), input);
// From rt-wdf
// tWDF_setIncidentWave(r->child_left, gamma_left * (left_wave * ((1.0f / gamma_left) - 1.0f) - right_wave - incident_wave));
// tWDF_setIncidentWave(r->child_right, gamma_right * (right_wave * ((1.0f / gamma_right) - 1.0f) - left_wave - incident_wave));
}
static void set_incident_wave_for_parallel(tWDF* const wdf, float incident_wave, float input)
{
_tWDF* r = *wdf;
r->incident_wave_up = incident_wave;
float gamma_left = r->port_conductance_left * r->gamma_zero;
float gamma_right = r->port_conductance_right * r->gamma_zero;
float left_wave = tWDF_getReflectedWaveUp(r->child_left, input);
float right_wave = tWDF_getReflectedWaveUp(r->child_right, input);
// downPorts[0]->b = ( ( dl - 1 ) * downPorts[0]->a + dr * downPorts[1]->a + du * descendingWave );
// downPorts[1]->b = ( dl * downPorts[0]->a + ( dr - 1 ) * downPorts[1]->a + du * descendingWave );
tWDF_setIncidentWave(r->child_left, (gamma_left - 1.0f) * left_wave + gamma_right * right_wave + incident_wave, input);
tWDF_setIncidentWave(r->child_right, gamma_left * left_wave + (gamma_right - 1.0f) * right_wave + incident_wave, input);
}
//===================================================================
//================ Get Reflected Waves ==============================
static float get_reflected_wave_for_resistor(tWDF* const wdf, float input)
{
_tWDF* r = *wdf;
r->reflected_wave_up = 0.0f;
return r->reflected_wave_up;
}
static float get_reflected_wave_for_capacitor(tWDF* const wdf, float input)
{
_tWDF* r = *wdf;
r->reflected_wave_up = r->incident_wave_up;
return r->reflected_wave_up;
}
static float get_reflected_wave_for_resistive(tWDF* const wdf, float input)
{
_tWDF* r = *wdf;
r->reflected_wave_up = input;
return r->reflected_wave_up;
}
static float get_reflected_wave_for_inverter(tWDF* const wdf, float input)
{
_tWDF* r = *wdf;
r->reflected_wave_up = -1.0f * tWDF_getReflectedWaveUp(r->child_left, input);
return r->reflected_wave_up;
}
static float get_reflected_wave_for_series(tWDF* const wdf, float input)
{
_tWDF* r = *wdf;
//-( downPorts[0]->a + downPorts[1]->a );
r->reflected_wave_up = (-1.0f * (tWDF_getReflectedWaveUp(r->child_left, input) + tWDF_getReflectedWaveUp(r->child_right, input)));
return r->reflected_wave_up;
}
static float get_reflected_wave_for_parallel(tWDF* const wdf, float input)
{
_tWDF* r = *wdf;
float gamma_left = r->port_conductance_left * r->gamma_zero;
float gamma_right = r->port_conductance_right * r->gamma_zero;
//return ( dl * downPorts[0]->a + dr * downPorts[1]->a );
r->reflected_wave_up = (gamma_left * tWDF_getReflectedWaveUp(r->child_left, input) + gamma_right * tWDF_getReflectedWaveUp(r->child_right, input));
return r->reflected_wave_up;
}
static float get_reflected_wave_for_ideal(tWDF* const wdf, float input, float incident_wave)
{
return (2.0f * input) - incident_wave;
}
#define l2A 0.1640425613334452f
#define l2B -1.098865286222744f
#define l2Y 3.148297929334117f
#define l2K -2.213475204444817f
static float log2Approximation(float x)
{
return (l2A * x*x*x) + (l2B * x*x) + (l2Y * x) + l2K;
}
#define wX1 -3.684303659906469f
#define wX2 1.972967391708859f
#define wA 9.451797158780131e-3f
#define wB 0.1126446405111627f
#define wY 0.4451353886588814f
#define wK 0.5836596684310648f
static float wrightOmega3(float x)
{
if (x <= wX1)
{
return 0;
}
else if (x < wX2)
{
return (wA * x*x*x) + (wB * x*x) + (wY * x) + wK;
}
else
{
return x - logf(x);
}
}
static float wrightOmegaApproximation(float x)
{
float w3 = wrightOmega3(x);
return w3 - ((w3 - expf(x - w3)) / (w3 + 1.0f));
}
static float lambertW(float a, float r, float I, float iVT)
{
return wrightOmegaApproximation(((a + r*I) * iVT) + log((r * I) * iVT));
}
#define Is_DIODE 2.52e-9f
#define VT_DIODE 0.02585f
static float get_reflected_wave_for_diode(tWDF* const wdf, float input, float incident_wave)
{
_tWDF* n = *wdf;
float a = incident_wave;
float r = n->port_resistance_up;
return a + 2.0f*r*Is_DIODE - 2.0f*VT_DIODE*lambertW(a, r, Is_DIODE, 1.0f/VT_DIODE);
}
static float get_reflected_wave_for_diode_pair(tWDF* const wdf, float input, float incident_wave)
{
_tWDF* n = *wdf;
float a = incident_wave;
float sgn = 0.0f;
if (a > 0.0f) sgn = 1.0f;
else if (a < 0.0f) sgn = -1.0f;
float r = n->port_resistance_up;
return a + 2 * sgn * (r*Is_DIODE - VT_DIODE*lambertW(sgn*a, r, Is_DIODE, 1.0f/VT_DIODE));
}