magnet Class Reference

Class to hold the defining data for a permanent magnet, in particular the name, relative permeability and remanence. More...

Public Member Functions
	magnet ()
	magnet (const word &name, const scalar mur, const scalar Mr, const vector &orientation)
	magnet (Istream &is)
const word &	name () const
scalar	mur () const
const dimensionedScalar &	Mr () const
const vector &	orientation () const

Friends
Istream &	operator>> (Istream &is, magnet &m)
Ostream &	operator<< (Ostream &os, const magnet &m)

Detailed Description

Class to hold the defining data for a permanent magnet, in particular the name, relative permeability and remanence.

Source files

• magnet.H

Definition at line 51 of file magnet.H.

Constructor & Destructor Documentation

magnet() [1/3]

magnet ( )

inline

Definition at line 65 of file magnet.H.

magnet() [2/3]

magnet ( const word &  name, const scalar  mur, const scalar  Mr, const vector &  orientation  )

inline

Definition at line 73 of file magnet.H.

magnet() [3/3]

magnet ( Istream &  is )

inline

Definition at line 87 of file magnet.H.

Member Function Documentation

name()

const word& name ( ) const

inline

Definition at line 99 of file magnet.H.

mur()

scalar mur ( ) const

inline

Definition at line 105 of file magnet.H.

Mr()

const dimensionedScalar& Mr ( ) const

inline

Definition at line 111 of file magnet.H.

orientation()

const vector& orientation ( ) const

inline

Definition at line 117 of file magnet.H.

Friends And Related Function Documentation

operator>>

Istream& operator>> ( Istream &  is, magnet &  m  )

friend

Definition at line 125 of file magnet.H.

operator<<

Ostream& operator<< ( Ostream &  os, const magnet &  m  )

friend

Definition at line 138 of file magnet.H.

---

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

• applications/solvers/electromagnetics/magneticFoam/magnet.H