Warning, /MagneticField/VolumeBasedEngine/doc/VolumeBasedEngine.doc is written in an unsupported language. File is not indexed.
0001
0002 /*!
0003
0004 \page MagneticField_VolumeBasedEngine Package MagneticField/VolumeBasedEngine
0005
0006 <center>
0007 <small>
0008
0009 <!-- @CVS_TAG@ will be substituted at build time, no need to touch -->
0010 <a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/MagneticField/VolumeBasedEngine/?cvsroot=CMSSW&only_with_tag=@CVS_TAG@>Source code (CVS tag: @CVS_TAG@)</a> -
0011 <a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/MagneticField/VolumeBasedEngine/.admin/developers?rev=HEAD&cvsroot=CMSSW&content-type=text/vnd.viewcvs-markup>Administrative privileges</a>
0012 </small>
0013 </center>
0014
0015 \section desc Description
0016 <!-- Short description of what this package is supposed to provide -->
0017
0018 Engine for the volume-based magnetic field. For details, see CMS CR-2005/011.
0019
0020 \subsection interface Public interface
0021 <!-- List the classes that are provided for use in other packages (if any) -->
0022 No class is directly exposed to the user: field engines are accessed via the MagneticField interface.
0023
0024 The internal implementation is based on the following classes:
0025
0026 - VolumeBasedMagneticField : the concrete MagneticField engine.
0027 - MagGeometry : the class handling the field volume geometry; normally not used directly by end users.
0028
0029
0030 \subsection modules Modules
0031 <!-- Describe modules implemented in this package and their parameter set -->
0032
0033 - VolumeBasedMagneticFieldESProducer.
0034
0035 To use this engine you should include in the cfi:
0036
0037 <pre>
0038 include "Configuration/StandardSequences/data/MagneticField.cff"
0039 </pre>
0040
0041 \subsection tests Unit tests and examples
0042 <!-- Describe cppunit tests and example configuration files -->
0043 An example of field access using this engine is provided in MagneticField/Engine/test/testMagneticField.cfg.
0044
0045 \section status Status and planned development
0046 <!-- e.g. completed, stable, missing features -->
0047 Stable.
0048
0049 <hr>
0050 Last updated:
0051 @DATE@ Author: N. Amapane (CERN)
0052 */
0053
