ShipCompField Class Reference

Class that defines a magnetic field composed from many fields. More...

#include <ShipCompField.h>

Inheritance diagram for ShipCompField:

Collaboration diagram for ShipCompField:

Public Member Functions
	ShipCompField (const std::string &label, TVirtualMagField *firstField)
	Main constructor.
	ShipCompField (const std::string &label, TVirtualMagField *firstField, TVirtualMagField *secondField)
	Secondary constructor.
	ShipCompField (const std::string &label, const std::vector< TVirtualMagField * > &theFields)
	More general constructor.
virtual	~ShipCompField ()
	Destructor.
virtual void	Field (const Double_t *position, Double_t *B)
size_t	nComposite () const
	Get the number of fields in the composite.
std::span< TVirtualMagField *const >	getCompFields () const
	Get the vector of fields.
	ClassDef (ShipCompField, 1)
	ClassDef for ROOT.

Private Member Functions
	ShipCompField (const ShipCompField &)=delete
	Deleted copy and assignment operators.
ShipCompField &	operator= (const ShipCompField &)=delete

Private Attributes
std::vector< TVirtualMagField * >	theFields_
	The vector of the various magnetic field pointers comprising the composite.

Detailed Description

Class that defines a magnetic field composed from many fields.

Author

John Back J.J.B.nosp@m.ack@.nosp@m.warwi.nosp@m.ck.a.nosp@m.c.uk

Definition at line 19 of file ShipCompField.h.

Constructor & Destructor Documentation

ShipCompField() [1/4]

ShipCompField::ShipCompField	(	const std::string &	label,
		TVirtualMagField *	firstField
	)

Main constructor.

Parameters

[in]	label	A descriptive name/title/label for the composite field
[in]	firstField	The first magnetic field for the composite

Definition at line 14 of file ShipCompField.cxx.

    : TVirtualMagField(label.c_str()), theFields_() {
  theFields_.push_back(firstField);
}

ShipCompField() [2/4]

ShipCompField::ShipCompField	(	const std::string &	label,
		TVirtualMagField *	firstField,
		TVirtualMagField *	secondField
	)

Secondary constructor.

Parameters

[in]	label	A descriptive name/title/label for the composite field
[in]	firstField	The first magnetic field pointer for the composite
[in]	secondField	The second magnetic field pointer for the composite

Definition at line 20 of file ShipCompField.cxx.

    : TVirtualMagField(label.c_str()), theFields_() {
  theFields_.push_back(firstField);
  theFields_.push_back(secondField);
}

ShipCompField() [3/4]

ShipCompField::ShipCompField	(	const std::string &	label,
		const std::vector< TVirtualMagField * > &	theFields
	)

More general constructor.

Parameters

[in]	label	A descriptive name/title/label for the composite field
[in]	theFields	A vector of magnetic field pointers for the composite

Definition at line 28 of file ShipCompField.cxx.

    : TVirtualMagField(label.c_str()), theFields_(theFields) {}

~ShipCompField()

ShipCompField::~ShipCompField ( )

virtual

Destructor.

Definition at line 32 of file ShipCompField.cxx.

                              {
  // The destructor does nothing since this class does not own
  // the various TVirtualMagField pointers
}

ShipCompField() [4/4]

ShipCompField::ShipCompField ( const ShipCompField &  )

privatedelete

Deleted copy and assignment operators.

Member Function Documentation

ClassDef()

ShipCompField::ClassDef	(	ShipCompField	,
		1
	)

ClassDef for ROOT.

Field()

void ShipCompField::Field ( const Double_t *  position, Double_t *  B  )

virtual

The total magnetic field from all of the composite sources (linear superposition)

Parameters

[in]	position	The x,y,z global coordinates of the point
[out]	B	The x,y,z components of the magnetic field

Definition at line 37 of file ShipCompField.cxx.

                                                               {
  // Loop over the fields and do a simple linear superposition
 
  // First initialise the field components to zero
  B[0] = 0.0, B[1] = 0.0, B[2] = 0.0;
 
  for (auto* theField : theFields_) {
    if (theField) {
      // std::cout<<"Finding field for "<<theField->GetName()<<std::endl;
 
      // Find the magnetic field components for this part
      Double_t BVect[3] = {0.0, 0.0, 0.0};
      theField->Field(position, BVect);
 
      // Simple linear superposition of the B field components
      B[0] += BVect[0];
      B[1] += BVect[1];
      B[2] += BVect[2];
 
      // std::cout<<"B = "<<BVect[0]<<", "<<BVect[1]<<", "<<BVect[2]<<std::endl;
      // std::cout<<"BSum = "<<B[0]<<", "<<B[1]<<", "<<B[2]<<std::endl;
    }
  }
}

getCompFields()

std::span< TVirtualMagField *const > ShipCompField::getCompFields ( ) const

inline

Get the vector of fields.

Returns

a non-owning view of the fields

Definition at line 66 of file ShipCompField.h.

                                                         {
    return theFields_;
  }

nComposite()

size_t ShipCompField::nComposite ( ) const

inline

Get the number of fields in the composite.

Returns

the number of fields used in the composite

Definition at line 60 of file ShipCompField.h.

{ return theFields_.size(); }

operator=()

ShipCompField & ShipCompField::operator= ( const ShipCompField &  )

privatedelete

Member Data Documentation

theFields_

std::vector<TVirtualMagField*> ShipCompField::theFields_

private

The vector of the various magnetic field pointers comprising the composite.

Definition at line 80 of file ShipCompField.h.

---

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

• field/ShipCompField.h
• field/ShipCompField.cxx