Skip to content

Add and apply codespell config #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[codespell]
ignore-words-list = missings,rcall,linke,strat,nd,nodel
skip = CITATIONS.bib,*.html
6 changes: 3 additions & 3 deletions docs/src/examples/Ex103_PSC_IVMeasurement.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,16 @@ function main(;n = 3, Plotter = PyPlot, plotting = false, verbose = false, test
if otherScanProtocol
# scan protocol parameter
number_tsteps = 40
frequence = 10.0 * Hz
frequency = 10.0 * Hz
amplitude = 0.2 * V
tend = 1/frequence
tend = 1/frequency

# Define sinusoidal applied voltage
function sinusoidalScanProtocol(t)
if t == Inf
0.0
else
amplitude * sin(2.0 * pi * frequence * t)
amplitude * sin(2.0 * pi * frequency * t)
end
end

Expand Down
2 changes: 1 addition & 1 deletion docs/src/examples/Ex104_PSC_Photogeneration.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ these values are needed for putting the generation slightly on
end
################################################################################

# put here back the homogenous Neumann boundary conditions.
# put here back the homogeneous Neumann boundary conditions.
ctsys.fvmsys.boundary_factors[iphia, bregionJ2] = 0.0
ctsys.fvmsys.boundary_values[iphia, bregionJ2] = 0.0

Expand Down
2 changes: 1 addition & 1 deletion docs/src/examples/Ex108_CIGS_WithTraps.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ using ChargeTransport
using ExtendableGrids
using PyPlot

# function to initialize the grid for a possble extension to other p-i-n devices.
# function to initialize the grid for a possible extension to other p-i-n devices.
function initialize_pin_grid(refinementfactor, h_ndoping, h_pdoping_left, h_pdoping_trap, h_pdoing_right)
coord_ndoping = collect(range(0.0, stop = h_ndoping, length = 2 * refinementfactor))
coord_pdoping_left = collect(range(h_ndoping, stop = (h_ndoping + h_pdoping_left), length = 3 * refinementfactor))
Expand Down
2 changes: 1 addition & 1 deletion docs/src/examples/Ex109_Traps.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ using ChargeTransport
using ExtendableGrids
using PyPlot

# function to initialize the grid for a possble extension to other p-i-n devices.
# function to initialize the grid for a possible extension to other p-i-n devices.
function initialize_pin_grid(refinementfactor, h_ndoping, h_intrinsic, h_pdoping)
coord_ndoping = collect(range(0.0, stop = h_ndoping, length = 3 * refinementfactor))
coord_intrinsic = collect(range(h_ndoping, stop = (h_ndoping + h_intrinsic), length = 3 * refinementfactor))
Expand Down
2 changes: 1 addition & 1 deletion docs/src/examples/Ex201_PSC_tensorGrid.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ function main(;n = 3, Plotter = PyPlot, plotting = false, verbose = false, test
cellmask!(grid, [h_pdoping, 0.0], [h_ndoping + h_intrinsic, height], regionIntrinsic, tol = 1.0e-18)
cellmask!(grid, [h_ndoping + h_intrinsic, 0.0], [h_total, height], regionAcceptor, tol = 1.0e-18)

# specifiy outer regions
# specify outer regions
# metal interfaces
bfacemask!(grid, [0.0, 0.0], [0.0, height], bregionDonor) # BregionNumber = 1
bfacemask!(grid, [h_total, 0.0], [h_total, height], bregionAcceptor) # BregionNumber = 2
Expand Down
6 changes: 3 additions & 3 deletions examples/Ex103_PSC_IVMeasurement.jl
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,16 @@ function main(;n = 3, Plotter = PyPlot, plotting = false, verbose = false, test
if otherScanProtocol
## scan protocol parameter
number_tsteps = 40
frequence = 10.0 * Hz
frequency = 10.0 * Hz
amplitude = 0.2 * V
tend = 1/frequence
tend = 1/frequency

## Define sinusoidal applied voltage
function sinusoidalScanProtocol(t)
if t == Inf
0.0
else
amplitude * sin(2.0 * pi * frequence * t)
amplitude * sin(2.0 * pi * frequency * t)
end
end

Expand Down
2 changes: 1 addition & 1 deletion examples/Ex104_PSC_Photogeneration.jl
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ function main(;n = 5,
end
################################################################################

## put here back the homogenous Neumann boundary conditions.
## put here back the homogeneous Neumann boundary conditions.
ctsys.fvmsys.boundary_factors[iphia, bregionJ2] = 0.0
ctsys.fvmsys.boundary_values[iphia, bregionJ2] = 0.0

Expand Down
2 changes: 1 addition & 1 deletion examples/Ex108_CIGS_WithTraps.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ using ChargeTransport
using ExtendableGrids
using PyPlot

## function to initialize the grid for a possble extension to other p-i-n devices.
## function to initialize the grid for a possible extension to other p-i-n devices.
function initialize_pin_grid(refinementfactor, h_ndoping, h_pdoping_left, h_pdoping_trap, h_pdoing_right)
coord_ndoping = collect(range(0.0, stop = h_ndoping, length = 2 * refinementfactor))
coord_pdoping_left = collect(range(h_ndoping, stop = (h_ndoping + h_pdoping_left), length = 3 * refinementfactor))
Expand Down
2 changes: 1 addition & 1 deletion examples/Ex109_Traps.jl
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ using ChargeTransport
using ExtendableGrids
using PyPlot

## function to initialize the grid for a possble extension to other p-i-n devices.
## function to initialize the grid for a possible extension to other p-i-n devices.
function initialize_pin_grid(refinementfactor, h_ndoping, h_intrinsic, h_pdoping)
coord_ndoping = collect(range(0.0, stop = h_ndoping, length = 3 * refinementfactor))
coord_intrinsic = collect(range(h_ndoping, stop = (h_ndoping + h_intrinsic), length = 3 * refinementfactor))
Expand Down
2 changes: 1 addition & 1 deletion examples/Ex201_PSC_tensorGrid.jl
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ function main(;n = 3, Plotter = PyPlot, plotting = false, verbose = false, test
cellmask!(grid, [h_pdoping, 0.0], [h_ndoping + h_intrinsic, height], regionIntrinsic, tol = 1.0e-18)
cellmask!(grid, [h_ndoping + h_intrinsic, 0.0], [h_total, height], regionAcceptor, tol = 1.0e-18)

## specifiy outer regions
## specify outer regions
## metal interfaces
bfacemask!(grid, [0.0, 0.0], [0.0, height], bregionDonor) # BregionNumber = 1
bfacemask!(grid, [h_total, 0.0], [h_total, height], bregionAcceptor) # BregionNumber = 2
Expand Down
4 changes: 2 additions & 2 deletions pluto-examples/PSC_example.jl
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ begin

end # generation loop
#############################################################
## put here back the homogenous Neumann boundary conditions.
## put here back the homogeneous Neumann boundary conditions.
ctsys.fvmsys.boundary_factors[iphia, bregionJunction2] = 0.0
ctsys.fvmsys.boundary_values[iphia, bregionJunction2] = 0.0

Expand Down Expand Up @@ -878,7 +878,7 @@ begin

end # generation loop

## put here back the homogenous Neumann boundary conditions.
## put here back the homogeneous Neumann boundary conditions.
ctsys.fvmsys.boundary_factors[iphia, bregionJunction2] = 0.0
ctsys.fvmsys.boundary_values[iphia, bregionJunction2] = 0.0

Expand Down
10 changes: 6 additions & 4 deletions src/ct_physics.jl
Original file line number Diff line number Diff line change
Expand Up @@ -440,8 +440,9 @@ Creates Schottky boundary conditions. For the electrostatic potential we assume

``\\psi = - \\phi_S/q + U, ``

where ``\\phi_S`` corresponds to a given value (non-negative Schottky barrier) and ``U`` to the applied voltage. The quantitity ``\\phi_S`` needs to be specified in the main file.
For eletrons and holes we assume the following
where ``\\phi_S`` corresponds to a given value (non-negative Schottky barrier) and ``U`` to the applied voltage.
The quantity ``\\phi_S`` needs to be specified in the main file.
For electrons and holes we assume the following

``f[n_\\alpha] = z_\\alpha q v_\\alpha (n_\\alpha - n_{\\alpha, 0})``,

Expand Down Expand Up @@ -492,8 +493,9 @@ A mixed Schottky-Ohmic boundary type condition, where we impose on the electric

``\\psi = - \\phi_S/q + U, ``

with ``\\phi_S`` as given value (non-negative Schottky barrier) and ``U`` to the applied voltage. The quantitity ``\\phi_S`` needs to be specified in the main file.
For eletrons and holes we assume the following (Ohmic)
with ``\\phi_S`` as given value (non-negative Schottky barrier) and ``U`` to the applied voltage.
The quantity ``\\phi_S`` needs to be specified in the main file.
For electrons and holes we assume the following (Ohmic)

`` \\varphi_{\\alpha} = U``.
"""
Expand Down
21 changes: 11 additions & 10 deletions src/ct_system.jl
Original file line number Diff line number Diff line change
Expand Up @@ -605,7 +605,7 @@ mutable struct Data{TFuncs<:Function, TVoltageFunc<:Function, TGenerationData<:U

"""
An datatype containing the information, whether at least on quasi Fermi potential is
assumend to be continuous or discontinuous.
assumed to be continuous or discontinuous.
"""
qFModel :: QFModelType

Expand All @@ -616,7 +616,7 @@ mutable struct Data{TFuncs<:Function, TVoltageFunc<:Function, TGenerationData<:U
boundaryType :: Array{BoundaryModelType, 1}

"""
An array containing predefined functions for the applied bias in dependance of time
An array containing predefined functions for the applied bias in dependence of time
at each outer boundary.
"""
contactVoltageFunction :: Array{TVoltageFunc, 1}
Expand All @@ -627,8 +627,9 @@ mutable struct Data{TFuncs<:Function, TVoltageFunc<:Function, TGenerationData<:U
bulkRecombination :: BulkRecombination

"""
A function/Array containing the user-specific photogeneration rate. It can be a function
which is specified in the user example or an array which is read in and calculatd with,
A function/Array containing the user-specific photogeneration rate.
It can be a function which is specified in the user example
or an array which is read in and calculated with,
e.g., an external software.
"""
generationData :: TGenerationData
Expand Down Expand Up @@ -733,7 +734,7 @@ mutable struct Data{TFuncs<:Function, TVoltageFunc<:Function, TGenerationData<:U
###############################################################

"""
Within this template informations concerning the band-edge energy
Within this template, information concerning the band-edge energy
of each carrier is stored locally which saves allocations.
We have two of such templates due to the two point flux approximation schemes.
"""
Expand All @@ -745,14 +746,14 @@ mutable struct Data{TFuncs<:Function, TVoltageFunc<:Function, TGenerationData<:U
tempBEE2 :: Array{Float64, 1}

"""
Within this template informations concerning the effective DOS
Within this template, information concerning the effective DOS
of each carrier is stored locally which saves allocations.
We have two of such templates due to the two point flux approximation schemes.
"""
tempDOS1 :: Array{Float64, 1}

"""
See the desciption of tempDOS2.
See the description of tempDOS2.
"""
tempDOS2 :: Array{Float64, 1}

Expand Down Expand Up @@ -1532,7 +1533,7 @@ function get_current_val(ctsys, U, Uold, Δt) # DA: But caution, still need some
current = current + I[ii]
end

# DA: caution I[ipsi] not completly correct. In our examples, this does not effect something,
# DA: caution I[ipsi] not completely correct. In our examples, this does not effect something,
# but we need derivative here.
return current
end
Expand Down Expand Up @@ -1586,7 +1587,7 @@ $(TYPEDSIGNATURES)
Compute the electro-neutral solution for the Boltzmann approximation.
It is obtained by setting the left-hand side in
the Poisson equation equal to zero and solving for ``\\psi``.
The charge carriers may obey different statitics functions.
The charge carriers may obey different statistics functions.
Currently, this one is not well tested for the case of charge carriers beyond electrons and holes.
"""
function electroNeutralSolution(ctsys)
Expand Down Expand Up @@ -1661,7 +1662,7 @@ end
$(TYPEDSIGNATURES)

First try of debugger. Print the Jacobi matrix for a given node, i.e. the number of node in
the grid and not the excact coordinate. This is only done for the one dimensional case so far.
the grid and not the exact coordinate. This is only done for the one dimensional case so far.
"""
function printJacobi(node, sys)
ctdata = data(sys)
Expand Down
Loading