VectorDipole Class Reference

#include <vectordipole.hpp>

Public Member Functions
	VectorDipole ()
void	initialize (const double moment, const double center_x, const double center_y, const double center_z, const double tilt_angle_phi, const double tilt_angle_theta, const double xlimit_f, const double xlimit_z, const double IMF_Bx, const double IMF_By, const double IMF_Bz)
double	operator() (double x, double y, double z, coordinate component, unsigned int derivative=0, coordinate dcomponent=X) const

Private Attributes
bool	initialized = false
double	q [3]
double	center [3]
double	xlimit [2]
double	IMF [3]

Detailed Description

Definition at line 33 of file vectordipole.hpp.

Constructor & Destructor Documentation

VectorDipole()

VectorDipole::VectorDipole ( )

inline

Definition at line 42 of file vectordipole.hpp.

Member Function Documentation

initialize()

void VectorDipole::initialize	(	const double	moment,
		const double	center_x,
		const double	center_y,
		const double	center_z,
		const double	tilt_angle_phi,
		const double	tilt_angle_theta,
		const double	xlimit_f,
		const double	xlimit_z,
		const double	IMF_Bx,
		const double	IMF_By,
		const double	IMF_Bz )

Definition at line 34 of file vectordipole.cpp.

Here is the caller graph for this function:

operator()()

double VectorDipole::operator()	(	double	x,
		double	y,
		double	z,
		coordinate	component,
		unsigned int	derivative = 0,
		coordinate	dcomponent = X ) const

Definition at line 59 of file vectordipole.cpp.

Here is the call graph for this function:

Member Data Documentation

center

double VectorDipole::center[3]

private

Definition at line 37 of file vectordipole.hpp.

IMF

double VectorDipole::IMF[3]

private

Definition at line 39 of file vectordipole.hpp.

initialized

bool VectorDipole::initialized = false

private

Definition at line 35 of file vectordipole.hpp.

q

double VectorDipole::q[3]

private

Definition at line 36 of file vectordipole.hpp.

xlimit

double VectorDipole::xlimit[2]

private

Definition at line 38 of file vectordipole.hpp.

---

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

• backgroundfield/vectordipole.hpp
• backgroundfield/vectordipole.cpp