Standard Oxs_Ext Child Classes

An Oxs simulation is built as a collection of Oxs_Ext (Oxs Extension) objects. These are defined via Specify blocks in the input MIF 2 file. The reader will find the information and sample MIF file provided in that section to be a helpful adjunct to the material presented below. Addition example MIF 2 files can be found in the directory oommf/app/oxs/examples.

This section describes the Oxs_Ext classes available in the standard OOMMF distribution, including documentation of their Specify block initialization strings, and a list of some sample MIF files from the oommf/app/oxs/examples directory that use the class. The standard Oxs_Ext objects, i.e., those that are distributed with OOMMF, can be identified by the Oxs_ prefix in their names. Additional Oxs_Ext classes may be available on your system. Check local documentation for details.

In the following presentation, the Oxs_Ext classes are organized into 8 categories: atlases, meshes, energies, evolvers, drivers, scalar field objects, vector field objects, and MIF support classes. The following Oxs_Ext classes are currently available:

• Atlases
  

  	Oxs_BoxAtlas		Oxs_EllipseAtlas
  	Oxs_EllipsoidAtlas		Oxs_ImageAtlas
  	Oxs_MultiAtlas		Oxs_ScriptAtlas

• Meshes
  

  Oxs_RectangularMesh

  Oxs_PeriodicRectangularMesh

• Energies
  

  	Oxs_CubicAnisotropy		Oxs_Demag
  	Oxs_Exchange6Ngbr		Oxs_ExchangePtwise
  	Oxs_FixedZeeman		Oxs_RandomSiteExchange
  	Oxs_ScriptUZeeman		Oxs_SimpleDemag
  	Oxs_StageZeeman		Oxs_TransformZeeman
  	Oxs_TwoSurfaceExchange		Oxs_UniaxialAnisotropy
  	Oxs_UniformExchange		Oxs_UZeeman

• Evolvers
  

  	Oxs_CGEvolve		Oxs_EulerEvolve
  	Oxs_RungeKuttaEvolve		Oxs_SpinXferEvolve

• Drivers
  

  Oxs_MinDriver

  Oxs_TimeDriver

• Scalar Field Objects
  

  	Oxs_AtlasScalarField		Oxs_LinearScalarField
  	Oxs_RandomScalarField		Oxs_ScriptScalarField
  	Oxs_UniformScalarField		Oxs_VecMagScalarField
  	Oxs_ScriptOrientScalarField		Oxs_AffineOrientScalarField
  	Oxs_AffineTransformScalarField		Oxs_ImageScalarField

• Vector Field Objects
  

  	Oxs_AtlasVectorField		Oxs_FileVectorField
  	Oxs_PlaneRandomVectorField		Oxs_RandomVectorField
  	Oxs_ScriptVectorField		Oxs_UniformVectorField
  	Oxs_ScriptOrientVectorField		Oxs_AffineOrientVectorField
  	Oxs_AffineTransformVectorField		Oxs_MaskVectorField
  	Oxs_ImageVectorField

• MIF Support Classes
  

  Oxs_LabelValue

OOMMF Documentation Team
September 30, 2022