Skip to content

quatrex

QTBM

Initializing search

Home
Getting Started
User Guide
Contributing
API Reference

quatrex

Home
Getting Started
Getting Started
User Guide
User Guide
- Introduction
- Methodology
- Parameters
  Parameters
  - QuaTrEx
  - Device
  - Contact
  - SCSP
  - Poisson
  - SCBA
  - QTBM QTBM
    Table of contents
    
    max_batch_size
  - Electron
  - Phonon
  - Coulomb Screening
  - Photon
  - OBC
  - Lyapunov
  - Memoizer
  - Solver
  - Output
- Examples
  Examples
  - Carbon Nanotube
Contributing
API Reference
API Reference
- qttools
  qttools
  - qttools.boundary_conditions
    
    qttools.boundary_conditions
    
    qttools.boundary_conditions.lyapunov
    
    qttools.boundary_conditions.lyapunov
    
    qttools.boundary_conditions.lyapunov.doubling
    
    qttools.boundary_conditions.lyapunov.lyapunov
    
    qttools.boundary_conditions.lyapunov.spectral
    
    qttools.boundary_conditions.obc
    
    qttools.boundary_conditions.obc
    
    qttools.boundary_conditions.obc.obc
    
    qttools.boundary_conditions.obc.sancho_rubio
    
    qttools.boundary_conditions.obc.spectral
    
    qttools.boundary_conditions.boundary_system
    
    qttools.boundary_conditions.system_reduction
  - qttools.comm
    
    qttools.comm
    
    qttools.comm.comm
  - qttools.datastructures
    
    qttools.datastructures
    
    qttools.datastructures.dsdbcoo
    
    qttools.datastructures.dsdbcsr
    
    qttools.datastructures.dsdbsparse
    
    qttools.datastructures.routines
  - qttools.fft
    
    qttools.fft
    
    qttools.fft.convolve
    
    qttools.fft.ffts
  - qttools.greens_function_solver
    
    qttools.greens_function_solver
    
    qttools.greens_function_solver.inv
    
    qttools.greens_function_solver.rgf
    
    qttools.greens_function_solver.rgf_dist
    
    qttools.greens_function_solver.solver
  - qttools.kernels
    
    qttools.kernels
    
    qttools.kernels.datastructure
    
    qttools.kernels.datastructure
    
    qttools.kernels.datastructure.cupy
    
    qttools.kernels.datastructure.cupy
    
    qttools.kernels.datastructure.cupy.dsdbcoo
    
    qttools.kernels.datastructure.cupy.dsdbcsr
    
    qttools.kernels.datastructure.cupy.dsdbsparse
    
    qttools.kernels.datastructure.numba
    
    qttools.kernels.datastructure.numba
    
    qttools.kernels.datastructure.numba.dsdbcoo
    
    qttools.kernels.datastructure.numba.dsdbcsr
    
    qttools.kernels.datastructure.numba.dsdbsparse
    
    qttools.kernels.inplace
    
    qttools.kernels.inplace
    
    qttools.kernels.inplace.cupy
    
    qttools.kernels.inplace.cupy
    
    Inplace
    
    qttools.kernels.inplace.numba
    
    qttools.kernels.inplace.numba
    
    qttools.kernels.inplace.numba.inplace
    
    qttools.kernels.linalg
    
    qttools.kernels.linalg
    
    qttools.kernels.linalg.eig
    
    qttools.kernels.linalg.eigvalsh
    
    qttools.kernels.linalg.inv
    
    qttools.kernels.linalg.kron
    
    qttools.kernels.linalg.qr
    
    qttools.kernels.linalg.svd
    
    qttools.kernels.operator
  - qttools.nevp
    
    qttools.nevp
    
    qttools.nevp.beyn
    
    qttools.nevp.full
    
    qttools.nevp.nevp
  - qttools.profiling
    
    qttools.profiling
    
    qttools.profiling.profiler
  - qttools.utils
    
    qttools.utils
    
    qttools.utils.gpu_utils
    
    qttools.utils.inplace_utils
    
    qttools.utils.mpi_utils
    
    qttools.utils.solvers_utils
    
    qttools.utils.sparse_utils
    
    qttools.utils.stack_utils
  - qttools.wave_function_solver
    
    qttools.wave_function_solver
    
    qttools.wave_function_solver.cudss
    
    qttools.wave_function_solver.mumps
    
    qttools.wave_function_solver.solver
    
    qttools.wave_function_solver.superlu
- quatrex
  quatrex
  - quatrex.bandstructure
    
    quatrex.bandstructure
    
    quatrex.bandstructure.band_edges
    
    quatrex.bandstructure.contact
  - quatrex.core
    
    quatrex.core
    
    quatrex.core.constants
    
    quatrex.core.observables
    
    quatrex.core.qtbm
    
    quatrex.core.scba
    
    quatrex.core.sse
    
    quatrex.core.statistics
    
    quatrex.core.subsystem
    
    quatrex.core.utils
  - quatrex.coulomb_screening
    
    quatrex.coulomb_screening
    
    quatrex.coulomb_screening.polarization
    
    quatrex.coulomb_screening.solver
  - quatrex.device
    
    quatrex.device
    
    quatrex.device.contact
    
    quatrex.device.device
    
    quatrex.device.inputs
  - quatrex.electron
    
    quatrex.electron
    
    quatrex.electron.solver
    
    quatrex.electron.sse_coulomb_screening
    
    quatrex.electron.sse_fock
    
    quatrex.electron.sse_phonon
    
    quatrex.electron.sse_photon
  - quatrex.grid
    
    quatrex.grid
    
    quatrex.grid.energies
    
    quatrex.grid.kpoints
  - quatrex.phonon
    
    quatrex.phonon
    
    quatrex.phonon.polarization
    
    quatrex.phonon.solver
  - quatrex.photon
    
    quatrex.photon
    
    quatrex.photon.polarization
    
    quatrex.photon.solver
  - quatrex.post_processing
    
    quatrex.post_processing
    
    quatrex.post_processing.plot_ldos

Table of contents

max_batch_size

QTBM

Options for the quantum transmitting boundary method (QTBM).

max_batch_size#

max_batch_size: PositiveInt = 10

Made with Material for MkDocs