// BrUMaRe · tutorial

Institutio integra BrUMaRe

Omnia quae instrumentum facit, gradatim: a computatione CASTEP usque ad figuras et tabulas commentarii, dissertationis vel thesis. Formulae adhibitae, bonae consuetudines et modus citandi includuntur.

1. Conspectus

BrUMaRe exitus programmatum CASTEP [1], VASP et SIESTA legit et, pro quavis materia et quovis atomo, haec reddit:

  • structuram fasciarum, DOS et PDOS, cum spin sursum et deorsum;
  • fascias per orbitalia proiectas;
  • analysin structurae localis vitiorum (vacantiae, substitutivi vel interstitialis) et distortionis quam efficiunt;
  • thermodynamicam formationis et desorptionis hydrogenii;
  • densitatem oneris totam et polarizatam, in 3D, 2D et in profilis;
  • comparationem plurium computationum iuxta positarum.

Duo modi utendi eandem analysin faciunt:

Situs (navigatrum)Scriptum Python (botryon)
Ususfasciculos trahe; omnia in visu accommodapython3 brumare.py seed
Installationulla; fasciculi computatrum tuum non relinquuntPython 3.8+, numpy et matplotlib
Exitusfigurae PNG/SVG, .dat pro Origin, CHGCAR/XSF pro VESTA, .zip computationum, relationes .txteadem, in seed_plots/

Principium praecipuum: energia Fermi numquam iterum computatur. Valor adhibitus est ipse quem programma scripsit, pro quoque spin. Praefinito, fasciae et DOS energias originales servant et linea ductus-puncti EF notat; etiam E − EF eligi potest.

Modi utendi BrUMaRe

Nomen BrUMaRe Brunonem Macedo et Renatam Benedet coniungit, atque etiam acronymum est Brillouin-zone Utilities for Materials Research. Intus latet bruma, Lusitanice «nebula»: nubes electronica quam programma ostendit. Eadem analysis quattuor modis praesto est:

ModusCuiQuomodo incipere
Pagina interretialisanalysis interactiva, nihil installandumaperi brunohdmacedo.tech/brumare et fasciculos trahe
Applicatio computatrieadem interfacies ac haec pagina, in fenestra, sine interretipip install "brumare[gui]" et brumare-gui
Programma Windowseadem applicatio, iis qui Python non adhibentinstallator BrUMaRe-Setup.exe in pagina versionum
Linea mandatorumbotrya computatrorum et scriptapip install brumare vel brumare.py; deinde brumare mgh2_Fe

Applicatio computatri et .exe hanc ipsam interfaciem aperiunt, cum eisdem tabulis et exportationibus, bibliothecis inclusis: sine interreti operantur. Linea mandatorum etiam comparationem (brumare --comparar A,B,C) et relationem differentiae densitatis (--field diff) facit. Quisque modus partem De programmate habet cum nomine, versione, auctore, nexibus et modo citandi; in linea mandatorum, brumare --sobre adhibe. Interfacies Lusitanice, Anglice, Hispanice, Francogallice, Italice et Latine praesto est (--idioma in linea mandatorum).

Programmata sustentata: CASTEP, VASP et SIESTA

BrUMaRe exitus trium programmatum legit et omnia in eandem formam internam convertit. Fasciae, DOS, PDOS, analysis electronica, vitia, thermodynamica, densitas et comparatio eodem modo pro omnibus tribus operantur, et computationes diversorum programmatum in eadem tabula comparari possunt. Energia Fermi semper ea est quam programma scripsit.

ProgrammaFasciculiQuomodo gignantur
CASTEPseed.bands, .pdos_bin, .castep, .cell, .den_fmtsectio 2 huius institutionis
VASPcapsa computationis: vasprun.xml, KPOINTS, CHGCAR (et POSCAR/CONTCAR)LORBIT = 11 (proiectiones), ISPIN = 2 (spin), LCHARG = .TRUE. (densitas); KPOINTS modo lineae pro fasciis
SIESTASystemLabel.bands, .EIG, .KP, .PDOS, .STRUCT_OUT vel .XV, .RHO et exitus .out%block BandLines (vel BandPoints), %block ProjectedDensityOfStates, SaveRho true, Spin polarized

Quomodo onerare:

  • In navigatro: totam capsam trahe vel Aperire capsam adhibe. In VASP nomen capsae nomen computationis fit, quia fasciculi nomina fixa habent. Sine capsa, fasciculos ut nomen.vasprun.xml, nomen.KPOINTS et similia renomina.
  • In Python: brumare capsa_vasp/, brumare SystemLabel (SIESTA) vel simpliciter brumare intra capsam. In interfacie graphica, capsam et computationem ex indice elige.

Quid in quoque programmate mutetur:

  • VASP:
    • Proiectiones tantum sphaeras PAW circa atomos complectuntur; ideo summa PDOS infra DOS totam manet. Hoc solitum est.
    • In computatione fasciarum non sibi congrua, ipsum VASP commendat EF computationis sibi congruae adhibere: utramque onera et sibi congruam in DOS ex elige.
    • In computationibus non collinearibus, tantum pars tota proiectionum adhibetur.
  • SIESTA:
    • .PDOS PDOS iam a SIESTA computatam continet, cum stratis n, l et m et dilatatione in .fdf electa. Directe adhibetur.
    • Cum pondera per fasciam desint, fasciae proiectae non exstant.
    • Cum .bands et .EIG simul, fasciae ex via et DOS ex reticulo sibi congruo, sponte electo, veniunt.
  • Tantum in CASTEP: populatio Mulliken et generator computationum relationis, qui .cell et .param scribit.

2. Computationem in CASTEP parare

Verba clavis .param quae omnia ab instrumento adhibita gignunt:

TASK                    : SPECTRAL           ! vel GeometryOptimization, SinglePoint
SPECTRAL_TASK           : BANDSTRUCTURE      ! DOS pro reticulo denso
SPIN_POLARIZED          : TRUE
PDOS_CALCULATE_WEIGHTS  : TRUE               ! .pdos_bin scribit (PDOS et fasciae proiectae)
POPN_CALCULATE          : TRUE               ! Mulliken et vincula in .castep
WRITE_FORMATTED_DENSITY : TRUE               ! .den_fmt scribit (densitas oneris et spin)

Via fasciarum in .cell ponitur, in %BLOCK SPECTRAL_KPOINT_PATH [5]. Pro DOS quantitativa, alteram computationem cum SPECTRAL_TASK : DOS et reticulo Monkhorst–Pack denso [3] exsequere; deinde illam in DOS ex indica.

FasciculusAd quid
seed.bandsvalores proprii, EF cuiusque spin, pondera punctorum k et cellula: fasciae, DOS et hiatus
seed.pdos_binpondus cuiusque orbitalis in quaque fascia et puncto k: PDOS et fasciae proiectae
seed.castepstrata (2p, 3d…), orbitalia m, Mulliken [6][7], vincula, energiae, vires, Z valentiae
seed.cellordo specierum, structura vitii, basis ad relationes generandas
seed.den_fmt, .cube, CHGCARdensitas oneris et spin

3. Fasciculos aperire

  1. Instrumentum aperi et fasciculos in aream lineis interruptis circumdatam trahe, vel Aperire fasciculos preme.
  2. Quodque seedname computatio est. Plures simul onerare potes: vitium, structuram puram, relationes elementares et alia dopantia.
  3. × iuxta computationem adhibe ut eam removeas, vel Data purgare ut denuo incipias.
  4. Bulla ☀/☾ thema mutat; electio etiam pro paginis auctoris valet. Electrum linguae iuxta est.

4. Fasciae

Tabula Fasciae spin sursum et deorsum superpositos, iuxta positos vel unum tantum ostendit. Tituli punctorum altae symmetriae pro reticulis cubicis, tetragonalibus, orthorhombicis et hexagonalibus sponte agnoscuntur, vel in Tituli punctorum k scribuntur (exempli gratia G,X,M,G,Z,R,A,Z).

Praefinito axis energiae energias originales servat, cum linea ductus-puncti et valore EF; relatio etiam esse potest EF cuiusque spin vel EF communis (E − EF).

5. DOS et PDOS

DOS est summa functionum Gaussianarum per fascias et puncta k, cum dilatatione σ electa. PDOS in quinque gradus dividi potest:

GradusExemplum
ElementumMg, H, Fe
Orbitale lFe-s, Fe-p, Fe-d
Strata (n, l) pseudopotentialisMg 2p et Mg 3p
Pars mpx, py, pz, dz², dyz, dxz, dx²−y², dxy
t2g/eg et atomi singuliFe 3d t2g; Fe1, H25

Tabula Fasciae + DOS duo graphemata iuxta ponit, in eodem axe energiae.

6. Fasciae proiectae

In fasciis proiectis, magnitudo cuiusque puncti ponderi orbitalis in illa fascia et illo puncto k proportionalis est. Proiectiones in sectione Proiectio electas adhibent, in tabulis separatis vel superpositis.

7. Analysis electronica

Tabula Analysis pro quoque spin colligit:

  • EF in Ha et in eV;
  • VBM et CBM, numeratione electronum definitas (fasciae N et N+1), et hiatum directum vel indirectum cum punctis k;
  • utrum EF intra fasciam cadat;
  • N(EF) et polarizationem spin;
  • spin integratum;
  • occupationes integratas PDOS et centrum fasciae d;
  • Mulliken per speciem et per atomum;
  • vincula dopantis.

8. Graphematum editor

Statim sub quaque figura est tabula Graphema mutare: titulus, legenda et colores:

  • Titulus et axes: titulus, magnitudo, color, tituli axium, typus litterarum et fundus (album ad editionem vel colores situs).
  • Legenda: positio, magnitudo, titulus et margo.
  • Curvae: pro quaque curva color, nomen in legenda, ductus, crassitudo et visibilitas; etiam linea EF hic accommodatur.
  • In ipso graphemate: nomen legendae preme ut mutes. Mutationes in omnibus tabulis valent.
Graphematum editor
Graphematum editor.

9. Vitium et distortio

Tabula Vitium et thermodynamica vitium duobus modis agnoscit:

  • Cum structura pura relationis: quisque atomus suo loco, condicionibus periodicis, coniungitur, et genus (vacantia, substitutivum vel interstitiale) sponte invenitur.
  • Sine relatione: vitium cum "massa" ipsius supercellulae comparatur, id est cum atomis procul positis.

Computantur:

  • primi vicini: quodque vinculum X–H, exempli gratia, contra relationem et contra Mg–H in massa;
  • vincula vicinorum (exempli gratia H–Mg);
  • indices distortionis polyedri: Baur [9], ECoN [10], elongatio quadratica ⟨λ⟩ et variantia angularis σ² [8], volumen et anguli;
  • strata secunda;
  • cum relatione: campus translationum et radius perturbationis.
Tabula Vitium et thermodynamica
Interpretatio automatica et tabulae paginae Vitium et thermodynamica.

10. Thermodynamica

Potentialia chimica μi sunt energiae per atomum relationum elementarium, eisdem parametris computatae: Mg hcp, Fe bcc et \(\mu_\mathrm{H}=\tfrac12E(\mathrm{H_2})\). Cum .castep harum relationum onerantur, sponte implentur.

Computantur:

  • energia formationis vitii [16][17];
  • enthalpia formationis hydridi per molem H₂, et effectus vitii ΔΔH;
  • temperatura desorptionis secundum van ’t Hoff, cum ΔS ≈ entropia normali H₂ gasei [19];
  • energia remotionis H;
  • capacitas gravimetrica.

Formulae in sectione 18 sunt.

11. Computationes relationis generare

Per Computationes relationis ex hoc .cell generare, instrumentum .cell et .param scribit eodem functionali, limite, spin, tolerantiis et pseudopotentialibus ac computatio tua:

ComputatioUsus
seed_purostructura pura (relaxanda)
seed_dif_puro_fixohospes purus in geometria vitii (single point): Δρ sine dipolis relaxationis
seed_dif_sem_X, seed_dif_so_Xsine dopante et solum dopans, in eadem cellula (single point): densitas vinculi
seed_semH_perto, seed_semH_longeenergia remotionis H prope et procul a vitio
Mg_hcp, Fe_bcc, H_H2…potentialia chimica μ

Supercellulae idem omnino reticulum k ac vitium adhibent. Relationes elementares eandem densitatem punctorum k adhibent.

12b. Zona Brillouin et via k

Tabula Zona Brillouin primam zonam (cellulam Wigner–Seitz reticuli reciproci) cuiusvis crystalli computat, puncta altae symmetriae invenit, viam fasciarum construit et data ad computationem parata gignit.

  1. Structuram elige: computationem oneratam, exemplum (Si, Cu, Fe, Mg, rutilum, MgH₂…) vel reticulum manu scriptum (a, b, c, α, β, γ vel tres vectores).
  2. Tolerantia symmetriae: cum “Reticulum symmetrizare”, anguli et longitudines paene aequales accommodantur (0,5° et 0,5%), ut in SeeK-path; mutationes ostenduntur.
  3. Densitas viae et Δk: puncta per segmentum et reticula Monkhorst–Pack suggesta (nᵢ = ⌈|bᵢ|/Δk⌉) statuunt.
  4. Effectus: zona in 3D, genus reticuli, volumina, vectores, tabula punctorum, longitudines segmentorum et reticula.
  5. Data parata: CASTEP, VASP (KPOINTS), Quantum ESPRESSO (K_POINTS crystal_b), SIESTA (BandLines) et JSON.
  6. Linea mandatorum: brumare --zona-brillouin "fcc 5.431" vel brumare seed --zona-brillouin.

Symmetria et structurae. Cum atomis (computatio onerata, fasciculus CIF/POSCAR/.cell/XSF/QE/XYZ, numerus COD vel bibliotheca 51 materiarum litterarum), tabula gregem spatialem per moyo, successorem spglib, agnoscit: numerum, symbola Hermann–Mauguin et Hall, Pearson, systema, reticulum Bravais, gregem punctalem, operationes, inversionem et situs Wyckoff. Zona cellulam primitivam normatam adhibet, quae (et conventionalis) ut POSCAR, .cell, QE et CIF exportari potest. Cum structura, omnia 14 reticula Bravais (25 casus Setyawan et Curtarolo) puncta et vias normatas accipiunt, cum pymatgen comparata. Linea mandatorum: brumare --estrutura fasciculus.cif.

Coordinatae fractae in basi reciproca cellulae electae sunt: eandem cellulam in computatione adhibe. In supercellulis fasciae plicantur; ad viam normalem cellulam primitivam adhibe. Reticula cubica, CFC, CCC, hexagonalia, tetragonalia et orthorhombica Setyawan et Curtarolo (2010) sequuntur; in symmetria humili SeeK-path (Hinuma et al., 2017) commendatur.

12. Densitas oneris

In tabula Structura 3D et densitas, quantitates praesto sunt ρ tota, ρ↑, ρ↓, ρ↑ − ρ↓, |ρ↑ − ρ↓|, ζ = (ρ↑ − ρ↓)/ρ et Δρ.

  • 3D: isosuperficies accommodabilis, cum atomis, vinculis et cellula.
  • 2D: sectiones per planum.
  • Profilum: densitas secundum vinculum, cum minimo quod punctum criticum vinculi approximat.
  • Onera et momenta per atomum: partitio Voronoi [12], communis vel radicalis [13], et sphaera circa vitium.
  • Pro VESTA [15]: CHGCAR (forma VASP 5 cum elementis, ρ·V) vel XSF exporta. CHGCAR etiam programmati bader [14] servit.

13. Plana (h k l), pinacotheca et cellula

  • Indices cellulae basis: instrumentum multiplicitatem supercellulae agnoscit (exempli gratia 3×3×3 rutili MgH₂), et indices sunt materiae.
  • Axes naturales: axes sectionis directiones reticuli sequuntur; in (110), horizontalis [1̄10] et verticalis [001].
  • Sectio integra: sectio totam sectionem supercellulae tegit, cum ambitu cellulae.
  • Percursio: moderamen planum secundum normalem movet.
  • Pinacotheca: (110), (1̄10), (001), (100), (010), (101), (011) et (111) iuxta ostendit.
  • Tabula cellulae: densitas, capacitas H, coordinatio, distantiae per par et spatia dhkl.
Pinacotheca planorum
Pinacotheca planorum per dopans, cum densitate veri CHGCAR.

14. Contributio vitii: Δρ

Ut tantum effectum vitii videas, elige Quantitas → contributio vitii et, in Subtrahere ρ(B), densitatem materiae purae (sponte eligitur cum nomen "puro" continet). Tres modi sunt, a simplicissimo ad mundissimum:

  1. ρ(vitium) − ρ(purum relaxatum): effectum electronicum et relaxationem includit. Dipoli circa atomos motos apparent.
  2. ρ(vitium) − ρ(purum in geometria vitii), cum seed_dif_puro_fixo: idem reticulum et eaedem positiones. Tantum permutationem hospitis cum dopante ostendit.
  3. ρ(vitium) − ρ(sine dopante) − ρ(solum dopans), cum B et C: densitas vinculi dopantis, id est redistributio oneris dum vincula formantur.

Si reticula differunt, densitas subtracta in reticulo vitii iterum capitur. Instrumentum ostendit:

  • electrones acquisitos et amissos et summam;
  • ∫Δρ in sphaeris circa dopans;
  • translationem oneris per atomum (∫Δρ in cellula Voronoi cuiusque atomi).

Partes et sensus. Differentia fieri potest in toto (Δρ), in quoque spin (Δρ↑, Δρ↓) et in magnetizatione, Δ(ρ↑ − ρ↓). In Sensus differentiae, elige ρ(vitium) − ρ(purum) vel ρ(purum) − ρ(vitium). Valores positivi rubri, negativi caerulei sunt. Limes scalae colorum ± adhibe ut debilem redistributionem in vicinis extollas.

3D circa vitium. In Regio 3D, capsa ±3 ad ±6 Å in dopante centrata lobos Δρ cum vinculis ostendit.

Comparatio et VESTA. In tabula Comparatio, differentia cuiusque vitii contra relationem in 3D iuxta et in 2D in eodem plano apparet. Bulla Exportare ad VESTA: omnes computationes .zip cum una capsa per structuram facit. Quaeque capsa CHGCAR densitatum ρ, ρ↑, ρ↓, ρ↑ − ρ↓ et quattuor differentiarum continet, cum elementis et positionibus rectis, et ducem cum ambitu valorum et gradibus in VESTA.

Tabula Differentia densitatis

Relatio redistributioni oneris a vitio effectae dedicata, cum:

  • indicibus: ΔN, cumulatio, exhaustio et onus redistributum ½∫|Δ|; radii 50% et 90%; puncta maximae cumulationis et exhaustionis; dipolus redistributionis (\(\mathbf p=\int(\mathbf r-\mathbf r_c)\,\Delta\rho\,dV\), in e·Å et debye); mutatio momenti;
  • vinculis: ρ minima cuiusque vinculi dopans–vicinus contra idem vinculum hospitis in puro;
  • onere per atomum in ambabus structuris, atomis coniunctis;
  • triptychis ρ(purum) | ρ(vitium) | Δρ, in 2D et 3D;
  • profilo radiali ⟨Δ⟩(r) cum onere cumulato \(\Delta Q(r)=\int_0^r\Delta\rho\,4\pi r'^2dr'\);
  • mediis planaribus secundum a, b et c;
  • profilo secundum vinculum.

Omnia ad Origin et VESTA exportari possunt.

15. Comparatio computationum

In tabula Comparatio, computationes et, si adest, structuram puram relationis nota. Accipis:

  • tabulam cum una columna per computationem: energiae, Ef, ΔH, ΔΔH, Td, EF, hiatus, N(EF), polarizatio, occupatio et momentum d, Mulliken, Voronoi, ρ in puncto critico, coordinatio, vincula, ⟨λ⟩, σ², translationes, ΔV/V, cellula et vis residua;
  • graphemata: columnae, DOS et PDOS superpositae (ad EF cuiusque computationis alignatae), fasciae iuxta, vincula, translationes, densitas (etiam Δρ contra relationem) in eodem plano et profila.
Comparatio
Graphemata tabulae Comparatio (exemplum illustrativum).

16. Exportationes

ExitusFormaUsus
FiguraePNG, JPG, JXL (JPEG XL), WEBP, SVG (scala 3 = 300 dpi in 8×6 pollicibus)commentarii, dissertationes, theses
Fasciae, DOS/PDOS, pondera, sectiones, profila, comparatio.dat cum TAB et linea nominumOrigin, Excel, gnuplot
DensitasCHGCAR (VASP 5), XSFVESTA, Bader, XCrySDen
Computationes relationis.zip cum .cell, .param, LEIAME, scriptobotryon
.bands per spinseed_up.bands, seed_down.bandssumo [18] et alia
Relationes.txtanalysis, vitium, comparatio
Citatiobrumare_citacao.bibBrUMaRe, programmata et methodi adhibiti

In Origin: .dat trahe; linea nominum Long Name cuiusque columnae fit. In fasciis, columna prima est X; ceteras ut lineas delinea.

17. Scriptum Python

# omnia: fasciae, DOS/PDOS, analysis, vitium, densitas, structura
python3 brumare.py mgh2_Fe -e Mg,H,Fe
# vitium cum relatione et thermodynamica
python3 brumare.py mgh2_Fe --ref mgh2_puro --mu "Mg=@Mg_hcp,Fe=@Fe_bcc,H=@H_H2" --h-less mgh2_Fe_semH_perto
# computationes relationis generare
python3 brumare.py mgh2_Fe --gerar-referencias
# densitas: pinacotheca planorum, spin, CHGCAR pro VESTA
python3 brumare.py mgh2_Fe --planes todos --field spin --chgcar
# contributio vitii et translatio oneris per atomum
python3 brumare.py mgh2_Fe --field diff --subtract mgh2_Fe_dif_puro_fixo.den_fmt
# fascis pro VESTA: ρ, ρ↑, ρ↓, spin et differentiae (purum − vitium)
python3 brumare.py mgh2_Fe --vesta --subtract mgh2_puro.den_fmt --diff-sign puro-defeito
# textus (--sobre, citatio, auxilium -h) Latine; energiae ad E_F relatae loco originalium
python3 brumare.py mgh2_Fe --idioma la --fermi-ref spin

python3 brumare.py --idioma la -h omnes optiones Latine ostendit.

18. Formulae

DOS, cum ponderibus \(w_k\) et dilatatione Gaussiana \(\sigma\):

\[ g_s(E)=\sum_{k}w_k\sum_n \frac{1}{\sigma\sqrt{2\pi}}\exp\!\left[-\frac{(E-\varepsilon_{nks})^2}{2\sigma^2}\right],\qquad g^{\mathrm{PDOS}}_{s,\alpha}(E)=\sum_k w_k\sum_n p^{\alpha}_{nks}\,\delta_\sigma(E-\varepsilon_{nks}) \]

Hiatus, cum \(N\) numero electronum per spin: \(E_g=\min_k\varepsilon_{N+1,k}-\max_k\varepsilon_{N,k}\). Polarizatio: \(P=\dfrac{N_\uparrow(E_F)-N_\downarrow(E_F)}{N_\uparrow(E_F)+N_\downarrow(E_F)}\).

Distortio polyedri [9][10][8]:

\[ D=\frac1n\sum_i\frac{|d_i-\bar d|}{\bar d},\qquad \langle\lambda\rangle=\frac1n\sum_i\left(\frac{d_i}{l_0}\right)^2,\qquad \sigma^2=\frac{1}{m-1}\sum_j(\theta_j-\theta_0)^2,\qquad \mathrm{ECoN}=\sum_i e^{\,1-(d_i/d_\mathrm{av})^6} \]

Hic \(l_0\) est distantia centrum–vertex polyedri regularis eiusdem voluminis et \(\theta_0\) est 90° (octaedrum) vel 109,47° (tetraedrum).

Thermodynamica [16]:

\[ E_f=E_\mathrm{vit}-E_\mathrm{pur}-\sum_i n_i\mu_i,\qquad \Delta H_f=\frac{E-\sum_i N_i\mu_i}{N_\mathrm{H}/2},\qquad T_d=\frac{\Delta H}{\Delta S},\qquad \mu_\mathrm{H}=\tfrac12E(\mathrm{H}_2) \]

In Ef, \(n_i>0\) atomos additos significat. ΔH per molem H₂ est et ΔS normalis est 130,7 J/(mol·K).

Densitas: CASTEP et VASP \(\rho V\) scribunt. BrUMaRe \(\rho\) in e/ų adhibet, cum \(\int\rho\,dV=N_e\), \(\zeta=(\rho_\uparrow-\rho_\downarrow)/\rho\) et \(\Delta\rho=\rho_A-\rho_B-\rho_C\). In partitione Voronoi radicali, quodque punctum ad atomum pertinet qui \(|\mathbf r-\mathbf R_a|^2-r_a^2\) minuit, cum radiis covalentibus Cordero [11].

18b. Theoria integra et exempla

Omnes quantitates quas BrUMaRe computat, cum aequatione adhibita, et exemplum verum cuiusque programmatis, ut probes num effectus tuus sensum habeat.

Unitates et lectio cuiusque programmatis

ProgrammaQuid legaturConversio
CASTEP.bands (Ha), .pdos_bin, .castep, .den_fmt (ρV)\(1\,\mathrm{Ha}=27{,}211386\,\mathrm{eV}\); \(1\,\mathrm{Bohr}=0{,}529177\,\text{Å}\)
VASPvasprun.xml (eV), proiectiones PAW, CHGCAR (ρV)energiae iam in eV; \(\rho=\mathrm{CHGCAR}/V\)
SIESTA.bands, .EIG (eV), .PDOS parata, .RHO (e/Bohr³)\(\rho\,[\mathrm{e/\text{Å}^3}]=\rho\,[\mathrm{e/Bohr^3}]/0{,}529177^3\)
Quantum ESPRESSOdata-file-schema.xml (Ha; k em \(2\pi/a\))\(\mathbf k_\mathrm{frac}=\mathbf k_\mathrm{cart}\cdot\mathbf A^{T}/(2\pi)\)
ORCAexitus .out: orbitalia, energia, geometria, oneramolecula: unicum "punctum k"; DOS per Gaussianas graduum

Fasciae, hiatus et massa efficax

Cum \(N_s\) electronibus in spin \(s\), ultima fascia occupata est \(N_s\) et prima vacua est \(N_s+1\): \(E_\mathrm{VBM}=\max_k\varepsilon_{N_s,k}\), \(E_\mathrm{CBM}=\min_k\varepsilon_{N_s+1,k}\) e \(E_g=E_\mathrm{CBM}-E_\mathrm{VBM}\). In moleculis (ORCA), idem criterium hiatum HOMO–LUMO dat.

Massa efficax ex accommodatione parabolica circa extremum secundum viam venit:

\[ E(k)\approx E_0+\frac{\hbar^2 (k-k_0)^2}{2m^*}\quad\Rightarrow\quad \frac{m^*}{m_e}=\frac{\hbar^2}{2m_e\,c_2},\qquad \frac{\hbar^2}{2m_e}=3{,}80998\ \mathrm{eV\,\text{Å}^2} \]

In vertice (ut Γ), una massa pro quaque directione viae datur. Tantum computatur cum EF in hiatu est et via continua.

DOS, PDOS et gradus Fermi

\[ g_s(E)=\sum_k w_k\sum_n \frac{e^{-(E-\varepsilon_{nks})^2/2\sigma^2}}{\sigma\sqrt{2\pi}},\qquad N_s(E_F)=g_s(E_F),\qquad P=\frac{N_\uparrow-N_\downarrow}{N_\uparrow+N_\downarrow} \]

EF semper est valor a programmate scriptus. Praefinito, axis energias originales ostendit et linea ductus-puncti EF notat; fenestra E min/E max ab EF numeratur. Polarizatio tantum definitur cum \(N_\uparrow+N_\downarrow>0{,}05\) status/eV.

Centrum fasciae d: \(\varepsilon_d=\int E\,g_d(E)\,dE\big/\int g_d(E)\,dE\), usque ad EF (occupata) vel per totam fenestram.

Zona Brillouin

Zona per plana Bragg k·G = |G|²/2 in basi reciproca reducta (LLL) construitur; volumen contra (2π)³/V probatur et genus reticuli ex forma zonae agnoscitur.

\[ \mathbf b_1=2\pi\frac{\mathbf a_2\times\mathbf a_3}{V},\quad \mathbf a_i\cdot\mathbf b_j=2\pi\delta_{ij},\quad V_\mathrm{ZB}=\frac{(2\pi)^3}{V},\quad \mathbf k\cdot\mathbf G\le\tfrac12|\mathbf G|^2\ \ \forall\,\mathbf G,\quad k_i^\mathrm{frac}=\frac{\mathbf a_i\cdot\mathbf k}{2\pi},\quad n_i=\left\lceil\frac{|\mathbf b_i|}{\Delta k}\right\rceil \]

Correctio hiatus (forfex)

Functionalia LDA et GGA (ut PBE) hiatum minuunt, quia hiatus Kohn–Sham non est hiatus fundamentalis: deest discontinuitas derivatae functionalis permutationis et correlationis, et adest error delocalizationis. BrUMaRe correctionem post computationem praebet: forfex fascias vacuas (\(n>N_s\)) per \(\Delta\) rigide transfert, occupatis et EF non mutatis. \(\Delta\) dari potest, ex hiatu relationis (experimentali, HSE06 vel GW) computari, vel exemplari empirico PBE → G0W0 Morales-García, Valero et Illas (2017), in 66 solidis accommodato, aestimari.

\[ E_g^\mathrm{DFT}=E_\mathrm{CBM}-E_\mathrm{VBM},\qquad \varepsilon^\mathrm{corr}_{n\mathbf k s}=\varepsilon_{n\mathbf k s}+\Delta\,\Theta(n-N_s),\qquad \Delta_\mathrm{ref}=E_g^\mathrm{ref}-E_g^\mathrm{DFT},\qquad E_g^{G_0W_0}\approx 1{,}358\,E_g^\mathrm{PBE}+0{,}904\ \mathrm{eV} \]

Limites: forfex neque dispersionem fasciarum neque massas efficaces neque positionem graduum vitii vacuorum in hiatu corrigit; exemplar empiricum pro PBE valet (non LDA), hiatum non nullum requirit et aliquot decimas eV errat (Si: 1,74 eV aestimatum contra 1,17 eV experimentale). In supercellulis cum vitio, Δ materiae purae praefer. Ad vere corrigendum, computationem cum HSE06, rSCAN vel DFT+U repete. In linea mandatorum: --gap-corr mvi, --gap-corr ref --gap-ref 1.17 vel --gap-corr tesoura --tesoura 0.5.

Onera: Mulliken, Voronoi et Bader

  • Mulliken (CASTEP et ORCA): ex exitu programmatis lectum; onus \(q_a=Z_a-N_a\).
  • Voronoi: \(N_a=\int_{V_a}\rho\,dV\), cum \(V_a\) puncta atomo proxima \(a\) (vel, in versione radicali, quae minuunt \(|\mathbf r-\mathbf R_a|^2-r_a^2\)).
  • Bader [14]: quodque punctum reticuli gradientem ρ ad maximum sequitur (algorithmus Henkelman in reticulo); alvei in eodem atomo desinentes summant \(N_a\). Momentum magneticum: \(m_a=\int_{V_a}(\rho_\uparrow-\rho_\downarrow)\,dV\) in μB. In linea mandatorum, margines alveorum methodo near-grid (Tang, Sanville et Henkelman, 2009) emendantur, quae verum gradientem ρ sequitur et inclinationem reticuli tollit; effectus ab exsecutione relationis (pybader) minus quam 0,001 e per atomum medie differt.

Vitium, distortio et thermodynamica

\[ E_f=E_\mathrm{def}-E_\mathrm{puro}-\sum_i n_i\mu_i,\qquad \Delta H=\frac{E-\sum_iN_i\mu_i}{N_\mathrm H/2},\qquad T_d=\frac{\Delta H}{\Delta S},\qquad \langle\lambda\rangle=\frac1n\sum_i\Big(\frac{d_i}{l_0}\Big)^2 \]

Densitas et differentia densitatis

\[ \Delta\rho=\rho_\mathrm{def}-\rho_\mathrm{ref}\ [-\rho_C],\qquad Q_\mathrm{red}=\tfrac12\!\int|\Delta\rho|\,dV,\qquad \mathbf p=\int(\mathbf r-\mathbf r_c)\Delta\rho\,dV,\qquad \Delta Q(r)=\int_0^r\overline{\Delta\rho}\,4\pi r'^2dr' \]

Exempla vera (unum per programma)

Effectus ex veris fasciculis exitus obtenti; eos adhibe ut installationem probes.

Programma et systemaMandatumEffectus
CASTEP · MgH₂:Fe (supercellula 162 atomorum, spin)brumare mgh2_Fe -e Mg,H,FeEF = 1,837 eV; hiatus totus 1,394 eV, indirectus M→R; Fe–H 1,649–1,653 Å
VASP · Si (fasciae modo lineae)brumare Si_bands/hiatus 0,614 eV indirectus (Γ→prope X); m*e = 0,94 me; m*h(Γ) = 0,32 me
VASP · Fe₂O₃ ferromagneticum (LDA+U)brumare FeO_ldau/56 electrones ↑ et 36 ↓: momentum 20 μB (4 Fe³⁺ spin alti)
SIESTA · SrTiO₃brumare SrTiO3hiatus 2,25 eV indirectus R→Γ; O 2p in valentia; Ti 3d t2g/eg in conductione; ∫ρ = 40,000 e
Quantum ESPRESSO · Sibrumare capsa_cum_xml/hiatus 1,32 eV inter duo puncta k probationis (reticulum crassum)
ORCA · divinylbenzenum (molecula)brumare dvb_sp.outhiatus HOMO–LUMO 5,18 eV; onera Mulliken et Löwdin
Comparatio programmatumbrumare --comparar mgh2_Fe,Si_bands/,SrTiO3tabula comparacao.dat, DOS superpositae, fasciae iuxta et comparacao_citacao.bib

19. Cautiones et limites

  • DOS viae fasciarum tantum illustrandi causa est; pro numeris, reticulum densum adhibe.
  • Hiatus et margines tantum ex punctis k viae veniunt.
  • Partes m et t2g/eg in axibus Cartesianis cellulae sunt.
  • Energiae ad 0 K energiam puncti nulli non habent; Td aestimatio est ad inclinationes comparandas.
  • Eadem parametra: tantum computationes eodem functionali, limite, pseudopotentialibus et U compara.
  • Onera Voronoi aestimationes sunt; pro numeris quantitativis, Bader adhibe.
  • Δρ cum reticulis vel voluminibus diversis iterum capitur. Optima sunt reticula identica, cum dif_puro_fixo.

20. Quomodo citare

Si BrUMaRe operi tuo profuit, programma cita et, cum convenit, dissertationem et thesim auctoris. Cita etiam CASTEP [1] (vel VASP vel SIESTA) et VESTA [15], si eo usus es. Bulla Citare (.bib) instrumenti .bib depromit cum iis ipsis quae adhibuisti. Depromenda: brumare.bib · CITATION.cff · institutio in PDF · fons LaTeX (Lusitanice).

ABNT (NBR 6023)

Citationes in lingua originali servantur, ut editae sunt.

MACEDO, B. H. D. BrUMaRe: Brillouin-zone Utilities for Materials Research — análise de estrutura de bandas, DOS, PDOS, densidade de carga, defeitos e termodinâmica a partir de cálculos CASTEP, VASP e SIESTA. Versão 1.3.0. Foz do Iguaçu, 2026. Software. Disponível em: https://brunohdmacedo.tech/brumare/. Acesso em: [dia mês ano].
MACEDO, B. H. D. Influência de defeitos substitucionais nas propriedades estruturais, eletrônicas, termodinâmicas e de armazenamento do hidreto MgH₂: uma abordagem ab initio. 2025. Trabalho de Conclusão de Curso (Bacharelado em Engenharia Física) – Universidade Federal da Integração Latino-Americana, Foz do Iguaçu, 2025. Disponível em: https://dspace.unila.edu.br/items/8db3836e-925d-422f-9cd2-6ff3f9f02080.
MACEDO, B. H. D.; ZALEWSKI, W. Dataset_Machine_Learning_Exoplanets_2024. Mendeley Data, v. 3, 2024. DOI: 10.17632/wctcv34962.3.
MACEDO, B. H. D.; ZALEWSKI, W. Processamento automático de curvas de luz para a identificação de exoplanetas por meio de algoritmos de aprendizado de máquina. Revista Brasileira de Iniciação Científica, v. 11, e024021, 2024.
MACEDO, B. H. D. Influência de defeitos substitucionais no MgH₂: uma abordagem ab initio. Dissertação (Mestrado em Física Aplicada) – Programa de Pós-Graduação em Física Aplicada, Universidade Federal da Integração Latino-Americana, Foz do Iguaçu, [ano]. [em andamento: confira o título definitivo]

BibTeX

@misc{macedo2026brumare,
  author       = {Macedo, Bruno Henrique Dourado},
  title        = {{BrUMaRe}: {Brillouin-zone Utilities for Materials Research} --- análise de estrutura de bandas, {DOS}, {PDOS}, densidade de carga, defeitos e termodinâmica a partir de cálculos {CASTEP}, {VASP} e {SIESTA}},
  year         = {2026},
  version      = {1.3.0},
  howpublished = {\url{https://brunohdmacedo.tech/brumare/}},
  note         = {Código-fonte: \url{https://github.com/brunohdmacedo/brumare}}
}
@misc{macedo2025tcc,
  author       = {Macedo, Bruno Henrique Dourado},
  title        = {Influência de defeitos substitucionais nas propriedades estruturais, eletrônicas, termodinâmicas e de armazenamento do hidreto {MgH$_2$}: uma abordagem \textit{ab initio}},
  year         = {2025},
  howpublished = {Trabalho de Conclusão de Curso (Bacharelado em Engenharia Física), UNILA},
  url          = {https://dspace.unila.edu.br/items/8db3836e-925d-422f-9cd2-6ff3f9f02080},
  note         = {Orientador: Rodrigo Santos da Lapa}
}

@misc{macedo2024dataset,
  author = {Macedo, Bruno Henrique Dourado and Zalewski, Willian},
  title  = {Dataset\_Machine\_Learning\_Exoplanets\_2024},
  year   = {2024},
  howpublished = {Mendeley Data, v3},
  doi    = {10.17632/wctcv34962.3}
}
@mastersthesis{macedo2027dissertacao,
  author  = {Macedo, Bruno Henrique Dourado},
  title   = {Influência de defeitos substitucionais no {MgH$_2$}: uma abordagem \textit{ab initio}},
  school  = {PPGFISA, Universidade Federal da Integração Latino-Americana (UNILA)},
  address = {Foz do Iguaçu, PR},
  year    = {2027},
  type    = {Dissertação (Mestrado em Física Aplicada)},
  note    = {Orientador: J. R. C. Salgado; coorientador: R. S. da Lapa. Bolsa CNPq}
}

O TCC, o artigo e a base de dados foram conferidos no DSpace UNILA, na RBIC e no Mendeley Data; o título da dissertação (em andamento) ainda deve ser conferido. No GitHub, o arquivo CITATION.cff faz aparecer o botão “Cite this repository”.

21. Opera citata

  1. CLARK, S. J. et al. First principles methods using CASTEP. Z. Kristallogr., v. 220, p. 567–570, 2005. doi:10.1524/zkri.220.5.567.65075
  2. PERDEW, J. P.; BURKE, K.; ERNZERHOF, M. Generalized gradient approximation made simple. Phys. Rev. Lett., v. 77, p. 3865, 1996. doi:10.1103/PhysRevLett.77.3865
  3. MONKHORST, H. J.; PACK, J. D. Special points for Brillouin-zone integrations. Phys. Rev. B, v. 13, p. 5188, 1976. doi:10.1103/PhysRevB.13.5188
  4. SAKINTUNA, B.; LAMARI-DARKRIM, F.; HIRSCHER, M. Metal hydride materials for solid hydrogen storage: a review. Int. J. Hydrogen Energy, v. 32, p. 1121–1140, 2007. doi:10.1016/j.ijhydene.2006.11.022
  5. SETYAWAN, W.; CURTAROLO, S. High-throughput electronic band structure calculations. Comput. Mater. Sci., v. 49, p. 299–312, 2010. doi:10.1016/j.commatsci.2010.05.010
  6. MULLIKEN, R. S. Electronic population analysis on LCAO–MO molecular wave functions. I. J. Chem. Phys., v. 23, p. 1833, 1955. doi:10.1063/1.1740588
  7. SEGALL, M. D. et al. Population analysis of plane-wave electronic structure calculations of bulk materials. Phys. Rev. B, v. 54, p. 16317, 1996. doi:10.1103/PhysRevB.54.16317
  8. ROBINSON, K.; GIBBS, G. V.; RIBBE, P. H. Quadratic elongation. Science, v. 172, p. 567–570, 1971. doi:10.1126/science.172.3983.567
  9. BAUR, W. H. The geometry of polyhedral distortions. Acta Cryst. B, v. 30, p. 1195–1215, 1974. doi:10.1107/S0567740874004560
  10. HOPPE, R. Effective coordination numbers (ECoN) and mean fictive ionic radii (MEFIR). Z. Kristallogr., v. 150, p. 23–52, 1979. doi:10.1524/zkri.1979.150.1-4.23
  11. CORDERO, B. et al. Covalent radii revisited. Dalton Trans., p. 2832–2838, 2008. doi:10.1039/B801115J
  12. VORONOI, G. Nouvelles applications des paramètres continus à la théorie des formes quadratiques. J. Reine Angew. Math., v. 134, p. 198–287, 1908. doi:10.1515/crll.1908.134.198
  13. GELLATLY, B. J.; FINNEY, J. L. The radical alternative to the Voronoi polyhedron. J. Non-Cryst. Solids, v. 50, p. 313–329, 1982. doi:10.1016/0022-3093(82)90093-X
  14. HENKELMAN, G.; ARNALDSSON, A.; JÓNSSON, H. A fast and robust algorithm for Bader decomposition of charge density. Comput. Mater. Sci., v. 36, p. 354–360, 2006. doi:10.1016/j.commatsci.2005.04.010
  15. MOMMA, K.; IZUMI, F. VESTA 3 for three-dimensional visualization of crystal, volumetric and morphology data. J. Appl. Cryst., v. 44, p. 1272–1276, 2011. doi:10.1107/S0021889811038970
  16. FREYSOLDT, C. et al. First-principles calculations for point defects in solids. Rev. Mod. Phys., v. 86, p. 253–305, 2014. doi:10.1103/RevModPhys.86.253
  17. VAN DE WALLE, C. G.; NEUGEBAUER, J. First-principles calculations for defects and impurities. J. Appl. Phys., v. 95, p. 3851, 2004. doi:10.1063/1.1682673
  18. GANOSE, A. M.; JACKSON, A. J.; SCANLON, D. O. sumo. J. Open Source Softw., v. 3, p. 717, 2018. doi:10.21105/joss.00717
  19. CHASE, M. W. NIST-JANAF Thermochemical Tables. 4. ed. J. Phys. Chem. Ref. Data, Monograph 9, 1998.