kicad/eeschema/sim/sim_model_tline.cpp

197 lines
5.9 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2022 Mikolaj Wielgus
* Copyright (C) 2022 KiCad Developers, see AUTHORS.txt for contributors.
*
* 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 3
* 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, you may find one here:
* https://www.gnu.org/licenses/gpl-3.0.html
* or you may search the http://www.gnu.org website for the version 3 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#include <sim/sim_model_tline.h>
using PARAM = SIM_MODEL::PARAM;
SIM_MODEL_TLINE::SIM_MODEL_TLINE( TYPE aType )
: SIM_MODEL( aType ),
m_isInferred( false )
{
static std::vector<PARAM::INFO> z0 = makeZ0ParamInfo();
static std::vector<PARAM::INFO> rlgc = makeRlgcParamInfo();
switch( aType )
{
case TYPE::TLINE_Z0:
for( const PARAM::INFO& paramInfo : z0 )
AddParam( paramInfo );
break;
case TYPE::TLINE_RLGC:
for( const PARAM::INFO& paramInfo : rlgc )
AddParam( paramInfo );
break;
default:
wxFAIL_MSG( "Unhandled SIM_MODEL type in SIM_MODEL_TLINE" );
}
}
void SIM_MODEL_TLINE::ReadDataSchFields( unsigned aSymbolPinCount,
const std::vector<SCH_FIELD>* aFields )
{
if( GetFieldValue( aFields, PARAMS_FIELD ) != "" )
SIM_MODEL::ReadDataSchFields( aSymbolPinCount, aFields );
else
InferredReadDataFields( aSymbolPinCount, aFields );
}
void SIM_MODEL_TLINE::ReadDataLibFields( unsigned aSymbolPinCount,
const std::vector<LIB_FIELD>* aFields )
{
if( GetFieldValue( aFields, PARAMS_FIELD ) != "" )
SIM_MODEL::ReadDataLibFields( aSymbolPinCount, aFields );
else
InferredReadDataFields( aSymbolPinCount, aFields );
}
void SIM_MODEL_TLINE::WriteDataSchFields( std::vector<SCH_FIELD>& aFields ) const
{
SIM_MODEL::WriteDataSchFields( aFields );
if( m_isInferred )
inferredWriteDataFields( aFields );
}
void SIM_MODEL_TLINE::WriteDataLibFields( std::vector<LIB_FIELD>& aFields ) const
{
SIM_MODEL::WriteDataLibFields( aFields );
if( m_isInferred )
inferredWriteDataFields( aFields );
}
template <typename T>
void SIM_MODEL_TLINE::inferredWriteDataFields( std::vector<T>& aFields ) const
{
wxString value = GetFieldValue( &aFields, PARAMS_FIELD );
if( value == "" )
value = GetDeviceTypeInfo().fieldValue;
WriteInferredDataFields( aFields, value );
}
std::vector<PARAM::INFO> SIM_MODEL_TLINE::makeZ0ParamInfo()
{
std::vector<PARAM::INFO> paramInfos;
PARAM::INFO paramInfo = {};
paramInfo.name = "z0";
paramInfo.type = SIM_VALUE::TYPE_FLOAT;
paramInfo.unit = "Ω";
paramInfo.category = PARAM::CATEGORY::PRINCIPAL;
paramInfo.defaultValue = "";
paramInfo.description = "Characteristic impedance";
paramInfo.isSpiceInstanceParam = true;
paramInfo.isInstanceParam = false;
paramInfos.push_back( paramInfo );
paramInfo.name = "td";
paramInfo.type = SIM_VALUE::TYPE_FLOAT;
paramInfo.unit = "s";
paramInfo.category = PARAM::CATEGORY::PRINCIPAL;
paramInfo.defaultValue = "";
paramInfo.description = "Transmission delay";
paramInfo.isSpiceInstanceParam = true;
paramInfo.isInstanceParam = false;
paramInfos.push_back( paramInfo );
return paramInfos;
}
std::vector<PARAM::INFO> SIM_MODEL_TLINE::makeRlgcParamInfo()
{
std::vector<PARAM::INFO> paramInfos;
PARAM::INFO paramInfo = {};
paramInfo.name = "len";
paramInfo.type = SIM_VALUE::TYPE_FLOAT;
paramInfo.unit = "m";
paramInfo.category = PARAM::CATEGORY::PRINCIPAL;
paramInfo.defaultValue = "";
paramInfo.description = "Length";
paramInfo.isSpiceInstanceParam = false;
paramInfo.isInstanceParam = true;
paramInfos.push_back( paramInfo );
paramInfo.name = "r";
paramInfo.type = SIM_VALUE::TYPE_FLOAT;
paramInfo.unit = "Ω/m";
paramInfo.category = PARAM::CATEGORY::PRINCIPAL;
paramInfo.defaultValue = "0";
paramInfo.description = "Resistance per length";
paramInfo.isSpiceInstanceParam = false;
paramInfo.isInstanceParam = false;
paramInfos.push_back( paramInfo );
paramInfo.name = "l";
paramInfo.type = SIM_VALUE::TYPE_FLOAT;
paramInfo.unit = "H/m";
paramInfo.category = PARAM::CATEGORY::PRINCIPAL;
paramInfo.defaultValue = "0";
paramInfo.description = "Inductance per length";
paramInfo.isSpiceInstanceParam = false;
paramInfo.isInstanceParam = false;
paramInfos.push_back( paramInfo );
paramInfo.name = "g";
paramInfo.type = SIM_VALUE::TYPE_FLOAT;
paramInfo.unit = "1/(Ω m)";
paramInfo.category = PARAM::CATEGORY::PRINCIPAL;
paramInfo.defaultValue = "0";
paramInfo.description = "Conductance per length";
paramInfo.isSpiceInstanceParam = false;
paramInfo.isInstanceParam = false;
paramInfos.push_back( paramInfo );
paramInfo.name = "c";
paramInfo.type = SIM_VALUE::TYPE_FLOAT;
paramInfo.unit = "C/m";
paramInfo.category = PARAM::CATEGORY::PRINCIPAL;
paramInfo.defaultValue = "0";
paramInfo.description = "Capacitance per length";
paramInfo.isSpiceInstanceParam = false;
paramInfo.isInstanceParam = false;
paramInfos.push_back( paramInfo );
return paramInfos;
}
bool SIM_MODEL_TLINE::requiresSpiceModel() const
{
return GetType() == TYPE::TLINE_RLGC;
}