BLCMDcoil Class Reference

Inheritance diagram for BLCMDcoil:

List of all members.

---

Detailed Description

BLCMDcoil implements the coil command.

Note this class is derived from BLCoil, where the variables are defined and the real work is done.

Public Member Functions
	BLCMDcoil ()
	Default constructor. Defines the command, args, etc.
virtual	~BLCMDcoil ()
	Destructor.
	BLCMDcoil (const BLCMDcoil &r)
	Copy constructor.
G4String	commandName ()
	commandName() returns "coil".
int	command (BLArgumentVector &argv, BLArgumentMap &namedArgs)
	command() implements the coil command.
void	defineNamedArgs ()
	defineNamedArgs() defines the arguments to the command.

---

Constructor & Destructor Documentation

BLCMDcoil::BLCMDcoil

(

)

Default constructor. Defines the command, args, etc.

References BLCMDTYPE_ELEMENT, BLCommand::registerCommand(), BLCommand::setDescription(), and BLCommand::setSynopsis().

Referenced by command().

                     : BLCommand(), BLCoil()
{
        // register the commandName(), and its synopsis and description.
        registerCommand(BLCMDTYPE_ELEMENT);
        setSynopsis("defines a coil (part of a solenoid)");
        setDescription("A coil is a geometrical tube that can carry current\n"
                "when part of a solenoid. The field is computed for a set\n"
                "of nSheets infinitely-thin current sheets evenly spread\n"
                "radially. The solenoid specifies the actual current.\n"
                "For tracking the computation is too slow, so a field map\n"
                "on a grid in r and z is computed and written to filename\n"
                "(defaults to coilname.dat).\n"
                "While there are lots of parameters specifying the field map\n"
                "it is recommended to simply accept the defaults for all\n"
                "but innerRadius, outerRadius, length, material, and\n"
                "possibly tolerance. The other parameters will be determined\n"
                "so that the largest error is less than tolerance times the\n"
                "value of Bz at the center of the coil.\n"
                "If mapFile is given, the file is read in BLFieldMap format.\n"
                "The cache file contains the parameters, and is a field map "
                "in a binary format; it is automatically regenerated if any "
                "parameter changes.\n\n"
                "Note that maxR and maxZ are by default determined to be large "
                "enough so that the field falls below tolerance; this can be "
                "quote large.");
}

BLCMDcoil::~BLCMDcoil

(

)

[virtual]

Destructor.

{
}

BLCMDcoil::BLCMDcoil

(

const BLCMDcoil &

r

)

Copy constructor.

                                       : BLCommand(r), BLCoil(r)
{
}

---

Member Function Documentation

G4String BLCMDcoil::commandName

(

)

[inline, virtual]

commandName() returns "coil".

Implements BLCommand.

{ return "coil"; }

int BLCMDcoil::command	(	BLArgumentVector &	argv,
		BLArgumentMap &	namedArgs
	)			[virtual]

command() implements the coil command.

Implements BLCommand.

References BLCMDcoil(), BLCoil::generateFieldMap(), BLCommand::getMaterial(), BLCommand::handleNamedArgs(), BLCoil::mapCoil, BLCoil::printCoil(), and BLCommand::printError().

{
        if(argv.size() != 1) {
                printError("coil: Invalid command, must have name");
                return -1;
        }

        if(argv[0] == "default") {
                return defaultCoil.handleNamedArgs(namedArgs);
        }

        BLCMDcoil *t = new BLCMDcoil(defaultCoil);
        t->name = argv[0];
        int retval = t->handleNamedArgs(namedArgs);

        if(t->filename == "")
                t->filename = t->name + ".dat";

        // check material exists
        if(t->material.size() > 0) getMaterial(t->material,false);

        t->printCoil();

        // add this coil to the list, and compute its fieldMap
        mapCoil[t->name] = t;
        t->generateFieldMap();

        return retval;
}

void BLCMDcoil::defineNamedArgs

(

)

[virtual]

defineNamedArgs() defines the arguments to the command.

Reimplemented from BLCommand.

References BLCommand::argDouble(), BLCommand::argInt(), BLCommand::argString(), BLCoil::dR, BLCoil::dZ, BLCoil::exactComputation, BLCoil::filename, BLCoil::innerRadius, BLCoil::length, BLCoil::mapFile, BLCoil::material, BLCoil::maxR, BLCoil::maxZ, BLCoil::nSheets, BLCoil::outerRadius, and BLCoil::tolerance.

{
        argDouble(innerRadius,"innerRadius","Inside radius of the coil (mm)",mm,"",false);
        argDouble(outerRadius,"outerRadius","Outside radius of the coil (mm)",mm,"",false);
        argDouble(length,"length","Length of the coil along z (mm)",mm,"",false);
        argString(material,"material","The material of the conductor (default=Cu)",false);
        argDouble(tolerance,"tolerance","The acceptable tolerance of the map.",1,"",false);
        argInt(nSheets,"nSheets","Number of sheets used in the computation",false);
        argDouble(maxR,"maxR","Maxmum r value for the map (automatically determined by default).",mm,"",false);
        argDouble(maxZ,"maxZ","Maxmum z value for the map (automatically determined by default).",mm,"",false);
        argDouble(dR,"dR","R interval between points of the map (automatically determined by default).",mm,"",false);
        argDouble(dZ,"dZ","Z interval between points of the map (automatically determined by default).",mm,"",false);
        argString(filename,"filename","Filename for cache; deaults to name.dat.",false);
        argString(mapFile,"mapFile","Filename for map (e.g. from TOSCA).",false);
        argInt(exactComputation,"exactComputation","Set nonzero to use the exact computation without any field map (0).");
}

---

The documentation for this class was generated from the following file:

• BLCMDcoil.cc