# This is a combination of 6 commits.

# This is the 1st commit message:

updates the descriptive comments for the biquadratic hamiltonia constructor to be consistent with updated argument names

# This is the commit message #2:

Update swfiles/+sw_classes/biquadratic_hamiltonian.m

Use more descriptive names for the biquadratic hamiltonian constructor

Co-authored-by: Anders Markvardsen <[email protected]>
# This is the commit message #3:

Renames the arguments of the hamiltonian class constructor to better
reflect its meaning

# This is the commit message #4:

Wrote a brief description of the variable 'nChunks'

# This is the commit message #5:

adds a description of nHkl as a comment

# This is the commit message #6:

Update swfiles/+sw_classes/magnetic_structure.m

Provides a brief comment on the 'magnetic_structure' class

Co-authored-by: Duc Le <[email protected]>

Author: krishnakumarg1984

swfiles/+sw_classes/biquadratic_hamiltonian.m

@@ -3,16 +3,16 @@
     methods
         function self = biquadratic_hamiltonian(JJ, dR, atom1, atom2, u, v, S_mag)
             % Calculates the biquadratic Hamiltonian
-            % Syntax: bq_ham = sw_classes.biquadratic_hamiltonia(JJ, dR, i, j, u, v, S_mag)
+            % Syntax: bq_ham = sw_classes.biquadratic_hamiltonia(JJ, dR, atom1, atom2, u, v, S_mag)
             % Inputs:
-            %   JJ    % The biquadratic couplings (1 x nCoupling vector)
-            %   dR    % The difference position vector between atom i and j
-            %   i     % The i indices (1 x nCoupling vector)
-            %   j     % The j indices (1 x nCoupling vector)
-            %   u     % The u vectors (zed in original code, 3 x nMagExt)
-            %   v     % The v vectors (eta in original code, 3 x nMagExt)
-            %   Smag  % The magnetic moment magnitude (1 x nMagExt vector)
-            
+            %   JJ     % The biquadratic couplings (1 x nCoupling vector)
+            %   dR     % The difference position vector between atom i and j
+            %   atom1  % The atom1 indices (1 x nCoupling vector)
+            %   atom2  % The atom2 indices (1 x nCoupling vector)
+            %   u      % The u vectors (zed in original code, 3 x nMagExt)
+            %   v      % The v vectors (eta in original code, 3 x nMagExt)
+            %   S_mag  % The magnetic moment magnitude (1 x nMagExt vector)
+
             self.dR = dR;
             self.nMagExt = max([atom1 atom2]);
             JJ = transpose(JJ);
@@ -21,7 +21,7 @@
 
             % In this case the coupling constants JJ are scalars
             % (In the bilinear Hamiltonian they are 3x3 matrices)
-            % So we just compute the uv factors converting from 
+            % So we just compute the uv factors converting from
             % the spins in the rotating to boson operators here
             bqM = sum(v(atom1,:) .* v(atom2,:), 2);
             bqN = sum(v(atom1,:) .* u(atom2,:), 2);
@@ -59,4 +59,3 @@
         end
     end
 end
-

swfiles/+sw_classes/hamiltonian.m

@@ -15,16 +15,16 @@
     methods
         function self = hamiltonian(JJ, dR, atom1, atom2, u, v, S_mag)
             % Calculates the (bilinear) Hamiltonian: sum_ij Si x Jij x Sj
-            % Syntax: ham = sw_classes.hamiltonia(JJ, dR, i, j, u, v, S_mag)
+            % Syntax: ham = sw_classes.hamiltonia(JJ, dR, atom1, atom2, u, v, S_mag)
             % Inputs:
             %   JJ    % The magnetic couplings (3 x 3 x nCoupling array)
             %   dR    % The difference position vector between atom i and j
-            %   i     % The i indices (1 x nCoupling vector)
-            %   j     % The j indices (1 x nCoupling vector)
+            %   atom1 % The atom1 indices (1 x nCoupling vector)
+            %   atom2 % The atom2 indices (1 x nCoupling vector)
             %   u     % The u vectors (zed in original code, 3 x nMagExt)
             %   v     % The v vectors (eta in original code, 3 x nMagExt)
-            %   Smag  % The magnetic moment magnitude (1 x nMagExt vector)
-            
+            %   S_mag % The magnetic moment magnitude (1 x nMagExt vector)
+
             % Don't know why we need to do this, but otherwise need to take a conj later
             u = conj(u);  % (or the equations don't match Toth & Lake...)
 
@@ -56,7 +56,7 @@
 
             % The upper right block B^ij in eq (26) of Toth & Lake:
             BC0 =  SiSj.*squeeze(sum(sum(uT_i.*JJ.*u_j,2),1));
-            idxB = [atom1' (atom2' + nMagExt)]; % For upper right block 
+            idxB = [atom1' (atom2' + nMagExt)]; % For upper right block
 
             self.subblocks = {AD0 2*BC0 conj(AD0)};
             self.subidx = [idxA1; idxB; idxD1];

swfiles/+sw_classes/magnetic_structure.m

@@ -1,4 +1,5 @@
 classdef magnetic_structure < handle
+    % Class to handle information required by the spin wave calculations from the magnetic structure
     properties
         S      % Magnetic moments, 3xN array; N=number of spins
         k      % Magnetic propagation vector, 3x1 vector

swfiles/+sw_classes/qvectors.m

@@ -1,10 +1,10 @@
 classdef qvectors < handle
     properties
         hkl
-        nChunk
+        nChunk   % number of times to process (by taking into account the avalable memory)
     end
     properties(SetAccess=private)
-        nHkl
+        nHkl     % number of hkl points to calculate for (scalar)
         hklIdx
     end
     methods