Vlasiator ebf0dd394 on dev (v5.4.0 + 1054 commits)
Loading...
Searching...
No Matches
Dipole Class Reference

#include <dipole.hpp>

Public Member Functions

 Dipole ()
void initialize (const double moment, const double center_x, const double center_y, const double center_z, const double tilt_angle)
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]

Detailed Description

Definition at line 32 of file dipole.hpp.

Constructor & Destructor Documentation

◆ Dipole()

Dipole::Dipole ( )
inline

Definition at line 39 of file dipole.hpp.

Member Function Documentation

◆ initialize()

void Dipole::initialize ( const double moment,
const double center_x,
const double center_y,
const double center_z,
const double tilt_angle = 0 )

Definition at line 32 of file dipole.cpp.

Here is the caller graph for this function:

◆ operator()()

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

Definition at line 44 of file dipole.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ center

double Dipole::center[3]
private

Definition at line 36 of file dipole.hpp.

◆ initialized

bool Dipole::initialized = false
private

Definition at line 34 of file dipole.hpp.

◆ q

double Dipole::q[3]
private

Definition at line 35 of file dipole.hpp.

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