tcad-devsim/devsim/testing/cap2.py

# Copyright 2013 DEVSIM LLC
#
# SPDX-License-Identifier: Apache-2.0

####
#### cap2.py
#### tests physics of cap made of two insulating regions
####
import array
from devsim import (
    add_1d_contact,
    add_1d_interface,
    add_1d_mesh_line,
    add_1d_region,
    contact_equation,
    create_1d_mesh,
    create_device,
    delete_contact_equation,
    delete_edge_model,
    delete_equation,
    delete_interface_equation,
    delete_interface_model,
    delete_node_model,
    edge_from_node_model,
    edge_model,
    edge_solution,
    equation,
    finalize_mesh,
    get_contact_charge,
    get_contact_equation_command,
    get_contact_equation_list,
    get_contact_list,
    get_edge_model_values,
    get_equation_command,
    get_equation_list,
    get_interface_equation_command,
    get_interface_equation_list,
    get_interface_list,
    get_matrix_and_rhs,
    get_node_model_values,
    get_region_list,
    interface_equation,
    interface_model,
    node_model,
    node_solution,
    print_edge_values,
    print_node_values,
    set_edge_values,
    set_node_value,
    set_node_values,
    set_parameter,
    solve,
    edge_average_model,
)

device = "MyDevice"
interface = "MySiOx"
regions = ("MyOxRegion", "MySiRegion")

create_1d_mesh(mesh="cap")
add_1d_mesh_line(mesh="cap", pos=0, ps=0.1, tag="top")
add_1d_mesh_line(mesh="cap", pos=0.5, ps=0.1, tag="mid")
add_1d_mesh_line(mesh="cap", pos=1, ps=0.1, tag="bot")
add_1d_contact(mesh="cap", name="top", tag="top", material="metal")
add_1d_contact(mesh="cap", name="bot", tag="bot", material="metal")
add_1d_interface(mesh="cap", name="MySiOx", tag="mid")
add_1d_region(mesh="cap", material="Si", region="MySiRegion", tag1="top", tag2="mid")
add_1d_region(mesh="cap", material="Ox", region="MyOxRegion", tag1="mid", tag2="bot")
finalize_mesh(mesh="cap")
create_device(mesh="cap", device=device)

set_parameter(
    device=device, region="MySiRegion", name="Permittivity", value=11.1 * 8.85e-14
)
set_parameter(device=device, region="MySiRegion", name="ElectricCharge", value=1.6e-19)

set_parameter(
    device=device, region="MyOxRegion", name="Permittivity", value=3.9 * 8.85e-14
)

set_parameter(device=device, region="MyOxRegion", name="ElectricCharge", value=1.6e-19)

for region in regions:
    node_solution(device=device, region=region, name="Potential")
    edge_from_node_model(device=device, region=region, node_model="Potential")

    edge_model(
        device=device,
        region=region,
        name="ElectricField",
        equation="(Potential@n0 - Potential@n1)*EdgeInverseLength",
    )

    edge_model(
        device=device,
        region=region,
        name="ElectricField:Potential@n0",
        equation="EdgeInverseLength",
    )

    edge_model(
        device=device,
        region=region,
        name="ElectricField:Potential@n1",
        equation="-EdgeInverseLength",
    )

    edge_model(
        device=device,
        region=region,
        name="PotentialEdgeFlux",
        equation="Permittivity*ElectricField",
    )
    edge_model(
        device=device,
        region=region,
        name="PotentialEdgeFlux:Potential@n0",
        equation="diff(Permittivity*ElectricField, Potential@n0)",
    )
    edge_model(
        device=device,
        region=region,
        name="PotentialEdgeFlux:Potential@n1",
        equation="-PotentialEdgeFlux:Potential@n0",
    )

    equation(
        device=device,
        region=region,
        name="PotentialEquation",
        variable_name="Potential",
        node_model="",
        edge_model="PotentialEdgeFlux",
        time_node_model="",
        variable_update="default",
    )

set_parameter(device=device, region="MySiRegion", name="topbias", value=1.0)
set_parameter(device=device, region="MyOxRegion", name="botbias", value=0.0)


conteq = "Permittivity*ElectricField"

node_model(
    device=device,
    region="MySiRegion",
    name="topnode_model",
    equation="Potential - topbias",
)
node_model(
    device=device, region="MySiRegion", name="topnode_model:Potential", equation="1"
)
edge_model(
    device=device, region="MySiRegion", name="contactcharge_edge_top", equation=conteq
)

node_model(
    device=device,
    region="MyOxRegion",
    name="botnode_model",
    equation="Potential - botbias",
)
node_model(
    device=device, region="MyOxRegion", name="botnode_model:Potential", equation="1"
)
edge_model(
    device=device,
    region="MyOxRegion",
    name="contactcharge_edge_bottom",
    equation=conteq,
)

contact_equation(
    device=device,
    contact="top",
    name="PotentialEquation",
    node_model="topnode_model",
    edge_model="",
    node_charge_model="",
    edge_charge_model="contactcharge_edge_top",
    node_current_model="",
    edge_current_model="",
)

contact_equation(
    device=device,
    contact="bot",
    name="PotentialEquation",
    node_model="botnode_model",
    edge_model="",
    node_charge_model="",
    edge_charge_model="contactcharge_edge_bottom",
    node_current_model="",
    edge_current_model="",
)

# type continuous means that regular equations in both regions are swapped into the primary region
interface_model(
    device=device,
    interface=interface,
    name="continuousPotential",
    equation="Potential@r0-Potential@r1",
)
interface_model(
    device=device,
    interface=interface,
    name="continuousPotential:Potential@r0",
    equation="1",
)
interface_model(
    device=device,
    interface=interface,
    name="continuousPotential:Potential@r1",
    equation="-1",
)
interface_equation(
    device=device,
    interface=interface,
    name="PotentialEquation",
    interface_model="continuousPotential",
    type="continuous",
)


solve(type="dc", absolute_error=1.0, relative_error=1e-10, maximum_iterations=30)

print((get_contact_charge(device=device, contact="top", equation="PotentialEquation")))
print((get_contact_charge(device=device, contact="bot", equation="PotentialEquation")))

print_edge_values(device=device, region="MySiRegion", name="PotentialEdgeFlux")
print_edge_values(device=device, region="MyOxRegion", name="PotentialEdgeFlux")
set_parameter(
    device=device, region="MySiRegion", name="Permittivity", value=1.0 * 8.85e-14
)
set_parameter(
    device=device, region="MyOxRegion", name="Permittivity", value=1.0 * 8.85e-14
)
print_edge_values(device=device, region="MySiRegion", name="PotentialEdgeFlux")
print_edge_values(device=device, region="MyOxRegion", name="PotentialEdgeFlux")

solve(type="dc", absolute_error=1.0, relative_error=1e-14, maximum_iterations=30)
print_edge_values(device=device, region="MySiRegion", name="PotentialEdgeFlux")
print_edge_values(device=device, region="MyOxRegion", name="PotentialEdgeFlux")
print((get_contact_charge(device=device, contact="top", equation="PotentialEquation")))
print((get_contact_charge(device=device, contact="bot", equation="PotentialEquation")))

set_parameter(device=device, name="Permittivity", value=11.1 * 8.85e-14)
set_parameter(
    device=device, region="MySiRegion", name="Permittivity", value=11.1 * 8.85e-14
)
set_parameter(
    device=device, region="MyOxRegion", name="Permittivity", value=3.9 * 8.85e-14
)

solve(type="dc", absolute_error=1.0, relative_error=1e-10, maximum_iterations=30)
print_edge_values(device=device, region="MySiRegion", name="PotentialEdgeFlux")
print_edge_values(device=device, region="MyOxRegion", name="PotentialEdgeFlux")
print_edge_values(device=device, region="MySiRegion", name="ElectricField")
print_edge_values(device=device, region="MyOxRegion", name="ElectricField")
print_node_values(device=device, region="MySiRegion", name="Potential")
print_node_values(device=device, region="MyOxRegion", name="Potential")
print((get_contact_charge(device=device, contact="top", equation="PotentialEquation")))
print((get_contact_charge(device=device, contact="bot", equation="PotentialEquation")))


#
# Edge Average Model
#
list1 = []
for i in ("ElectricField", "ElectricField:Potential@n0", "ElectricField:Potential@n1"):
    list1.append(get_edge_model_values(device=device, region="MySiRegion", name=i))
print(*zip(*list1))

edge_average_model(
    device=device,
    region="MySiRegion",
    edge_model="efield",
    node_model="Potential",
    average_type="negative_gradient",
)
edge_average_model(
    device=device,
    region="MySiRegion",
    edge_model="efield",
    node_model="Potential",
    average_type="negative_gradient",
    derivative="Potential",
)

list2 = []
for i in ("efield", "efield:Potential@n0", "efield:Potential@n1"):
    list2.append(get_edge_model_values(device=device, region="MySiRegion", name=i))
print(*zip(*list2))


def get_rlist():
    rlist = []
    for r in get_region_list(device=device):
        print("Region: " + r)
        for e in get_equation_list(device=device, region=r):
            print("Equation: " + e)
            cmd = get_equation_command(device=device, region=r, name=e)
            print("Options: " + str(cmd))
            rlist.append(get_equation_command(device=device, region=r, name=e))
    return rlist


def get_clist():
    clist = []
    for c in get_contact_list(device=device):
        print("Contact: " + c)
        for e in get_contact_equation_list(device=device, contact=c):
            print("Contact Equation: " + e)
            cmd = get_contact_equation_command(device=device, contact=c, name=e)
            print("Options: " + str(cmd))
            clist.append(cmd)
    return clist


def get_ilist():
    ilist = []
    for i in get_interface_list(device=device):
        print("Interface: " + i)
        for e in get_interface_equation_list(device=device, interface=i):
            print("Interface Equation: " + e)
            cmd = get_interface_equation_command(device=device, interface=i, name=e)
            print("Options: " + str(cmd))
            ilist.append(cmd)
    return ilist


rl = get_rlist()
cl = get_clist()
il = get_ilist()

print()
print()

for i in rl:
    delete_equation(device=i["device"], region=i["region"], name=i["name"])
for i in il:
    delete_interface_equation(
        device=i["device"], interface=i["interface"], name=i["name"]
    )
for i in cl:
    delete_contact_equation(device=i["device"], contact=i["contact"], name=i["name"])

get_rlist()
get_clist()
get_ilist()

# solve(type="dc", absolute_error=1.0, relative_error=1e-10, maximum_iterations=30)

for r in rl:
    equation(**r)
for c in cl:
    contact_equation(**c)
for i in il:
    interface_equation(**i)

solve(type="dc", absolute_error=1.0, relative_error=1e-10, maximum_iterations=30)
print(get_matrix_and_rhs())

node_solution(device=device, region="MySiRegion", name="testing")
set_node_value(device=device, region="MySiRegion", name="testing", value=8, index=3)
nv = get_node_model_values(device=device, region="MySiRegion", name="Potential")
print(nv)
set_node_value(device=device, region="MySiRegion", name="Potential", value=1.1)
print(get_node_model_values(device=device, region="MySiRegion", name="Potential"))
set_node_value(device=device, region="MySiRegion", name="Potential", value=0, index=3)
print(get_node_model_values(device=device, region="MySiRegion", name="Potential"))
set_node_values(
    device=device, region="MySiRegion", name="Potential", init_from="testing"
)
print(get_node_model_values(device=device, region="MySiRegion", name="Potential"))
set_node_values(device=device, region="MySiRegion", name="Potential", values=nv)
print(get_node_model_values(device=device, region="MySiRegion", name="Potential"))

solve(type="dc", absolute_error=1.0, relative_error=1e-10, maximum_iterations=30)

print_edge_values(device=device, region="MySiRegion", name="ElectricField")
edge_solution(device=device, region="MySiRegion", name="testcopy1")
print_edge_values(device=device, region="MySiRegion", name="testcopy1")
set_edge_values(
    device=device, region="MySiRegion", name="testcopy1", init_from="ElectricField"
)
print_edge_values(device=device, region="MySiRegion", name="testcopy1")
v = list(get_edge_model_values(device=device, region="MySiRegion", name="testcopy1"))
v[0] = -1
v[-1] = +2
set_edge_values(device=device, region="MySiRegion", name="testcopy1", values=v)
print_edge_values(device=device, region="MySiRegion", name="testcopy1")
edge_model(
    device=device,
    region="MySiRegion",
    name="testcopy2",
    equation="ElectricField-testcopy1",
)
print_edge_values(device=device, region="MySiRegion", name="testcopy2")

delete_edge_model(device=device, region="MySiRegion", name="ElectricField")
delete_node_model(device=device, region="MySiRegion", name="Potential")
delete_interface_model(device=device, interface=interface, name="continuousPotential")

x = get_node_model_values(device=device, region="MySiRegion", name="testing")
print(x)
x[0] = 1
print(x)
set_node_values(device=device, region="MySiRegion", name="testing", values=x)
set_node_values(device=device, region="MySiRegion", name="testing", values=list(x))
x = get_node_model_values(device=device, region="MySiRegion", name="testing")
x[1] = 2
print(x)
set_node_values(device=device, region="MySiRegion", name="testing", values=x.tobytes())
x = get_node_model_values(device=device, region="MySiRegion", name="testing")
x = b"\x00" * 8 * 6
print(x)
set_node_values(device=device, region="MySiRegion", name="testing", values=x)
x = get_node_model_values(device=device, region="MySiRegion", name="testing")
print(x)
x = array.array("i", [-1] * 6)
print(x)
set_node_values(device=device, region="MySiRegion", name="testing", values=x)
x = get_node_model_values(device=device, region="MySiRegion", name="testing")
print(x)
x = x.tobytes()
print(x)
x = get_node_model_values(device=device, region="MySiRegion", name="testing")
print(x)
x = array.array("i", b"\x01\x00\x00\x00" * 6)
print(x)
set_node_values(device=device, region="MySiRegion", name="testing", values=x)
x = get_node_model_values(device=device, region="MySiRegion", name="testing")
print(x)
x = array.array("Q", b"\x01\x00\x00\x00\x00\x00\x00\x00" * 6)
print(x)
set_node_values(device=device, region="MySiRegion", name="testing", values=x.tobytes())
x = get_node_model_values(device=device, region="MySiRegion", name="testing")
print(x)