calculates magnetic and nuclear structure factor
Syntax
sFact = structfact(obj, kGrid,Name,Value)
sfTable = structfact(obj, kGrid,Name,Value)
Description
sFact = structfact(obj, kGrid,Name,Value)
returns the calculated
structure factors in units of barn. Magnetic structures (FM, AFM and
helical) are checked against
FullProf. The structure factor
includes the site occupancy and Debye-Waller factors calculated from
obj.unit_cell.biso
, using the same definition as in FullProf.
Input Arguments
obj
- spinw object.
kGrid
- Defines the reciprocal lattice vectors where the structure factor is to be calculated. For commensurate structures these are the possible positions of the magnetic Bragg peaks. For incommensurate helical/conical structures 3 Bragg peaks positions are possible: $$(\mathbf{k}-\mathbf{k}_m,\mathbf{k},\mathbf{k}+\mathbf{k}_m) around every reciprocal lattice vector. In this case still the integer positions have to be given and the code calculates the intensities at all three points.
Name-Value Pair Arguments
'mode'
- String, defines the type of calculation:
mag
Magnetic structure factor and intensities for unpolarised neutron scattering.nucn
Nuclear structure factor and neutron scattering intensities.nucx
X-ray scattering structure factor and intensities.
'sortq'
- Sorting the reflections according to increasing momentum
value if
true
. Default isfalse
. 'formfact'
- If true, the magnetic form factor is included in the structure factor
calculation. The form factor coefficients are stored in
obj.unit_cell.ff(1,:,atomIndex)
. Default value isfalse
. 'formfactfun'
- Function that calculates the magnetic form factor for given value.
value. Default value is
@sw_mff
, that uses a tabulated coefficients for the form factor calculation. For anisotropic form factors a user defined function can be written that has the following header:F = formfactfun(atomLabel,Q)
where the parameters are:
F
row vector containing the form factor for every input valueatomLabel
string, label of the selected magnetic atomQ
matrix with dimensions of , where each column contains a vector in units.
'gtensor'
- If true, the g-tensor will be included in the structure factor calculation. Including anisotropic g-tensor or different g-tensor for different ions is only possible here.
'lambda'
- Wavelength. If given, the value for each reflection is calculated.
'dmin'
- Minimum -value of a reflection, all higher order reflections will be removed from the results.
'output'
- String, defines the type of the output:
struct
Results are returned in a struct type variable, default.table
Results are returned in a table type output for easy viewing and exporting.
'tol'
- Tolerance of the incommensurability of the magnetic ordering wavevector. Deviations from integer values of the ordering wavevector smaller than the tolerance are considered to be commensurate. Default value is .
'fitmode'
- Speed up the calculation for fitting mode (omitting
cloning the spinw object into the output). Default is
false
. 'fid'
- Defines whether to provide text output. The default value is determined
by the
fid
preference stored in swpref. The possible values are:0
No text output is generated.1
Text output in the MATLAB Command Window.fid
File ID provided by thefopen
command, the output is written into the opened file stream.
Output Arguments
sFact
- Structure with the following fields:
F2
Magnetic structure factor in a matrix with dimensions .Mk
Square of the 3 dimensional magnetic structure factor, dimensions are: , where is the size of the extended unit cell.hkl
Contains the input values in a matrix with dimensins of .hklA
Same ashkl
, but in Å units in the Cartesian coordinate system.incomm
Whether the spectra calculated is incommensurate or not.formfact
Cell containing the labels of the magnetic ions if form factor in included in the spin-spin correlation function.{tth}
value of the reflection for the given wavelength, only given if a wavelength is provided.obj
Clone of the inputobj
object.
sfTable
- Table, optional output for quick viewing and saving the output into a text file.
See Also
sw_qgrid | [sw_plotsf] | [sw_intsf] | spinw.anneal | spinw.genmagstr