Home > Scripts > Models > langevin.m

iFit/langevin

PURPOSE ^

y = langevin(p, x, [y]) : Langevin function for magnetic polarization

SYNOPSIS ^

function y=langevin(varargin)

DESCRIPTION ^

 y = langevin(p, x, [y]) : Langevin function for magnetic polarization

   iFunc/langevin Langevin function for magnetic polarization
     x = (x-p(2))/p(3); y  = p(4)+ p(1) .* ( coth(x) - 1./x );

 langevin(centre)         creates a model with a specified centre/threshold
 langevin([ parameters ]) creates a model with specified model parameters

 input:  p: Langevin model parameters (double)
            p = [ Amplitude Center Width BackGround ]
          or 'guess'
         x: axis (double)
         y: when values are given and p='guess', a guess of the parameters is performed (double)
 output: y: model value
 ex:     y=langevin([1 0 1 1], -10:10); or plot(langevin);

 Version: Mar. 22, 2017
 See also iFunc, iFunc/fits, iFunc/plot
 (c) E.Farhi, ILL. License: EUPL.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Wed 22-Mar-2017 09:13:30 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1