magnet Class Reference

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

Collaboration diagram for magnet:

Public Member Functions
	magnet ()
	Null constructor for lists. More...
	magnet (const word &name, const scalar mur, const scalar Mr, const vector &orientation)
	Construct from components. More...
	magnet (Istream &is)
	Construct from Istream. More...
const word &	name () const
	Return name. More...
scalar	mur () const
	Return relative permeability. More...
const dimensionedScalar &	Mr () const
	Return remenance. More...
const vector &	orientation () const
	Return orientation. More...

Private Attributes
word	name_
scalar	relativePermeability_
dimensionedScalar	remanence_
vector	orientation_

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 57 of file magnet.H.

Constructor & Destructor Documentation

magnet() [1/3]

magnet ( )

inline

Null constructor for lists.

Definition at line 71 of file magnet.H.

magnet() [2/3]

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

inline

Construct from components.

Definition at line 79 of file magnet.H.

magnet() [3/3]

magnet ( Istream &  is )

inline

Construct from Istream.

Definition at line 93 of file magnet.H.

Member Function Documentation

name()

const word& name ( ) const

inline

Return name.

Definition at line 105 of file magnet.H.

References magnet::name_.

mur()

scalar mur ( ) const

inline

Return relative permeability.

Definition at line 111 of file magnet.H.

References magnet::relativePermeability_.

Mr()

const dimensionedScalar& Mr ( ) const

inline

Return remenance.

Definition at line 117 of file magnet.H.

References magnet::remanence_.

orientation()

const vector& orientation ( ) const

inline

Return orientation.

Definition at line 123 of file magnet.H.

References magnet::orientation_.

Friends And Related Function Documentation

operator>>

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

friend

Definition at line 131 of file magnet.H.

operator<<

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

friend

Definition at line 146 of file magnet.H.

Field Documentation

name_

word name_

private

Definition at line 61 of file magnet.H.

Referenced by magnet::name(), Foam::operator<<(), and Foam::operator>>().

relativePermeability_

scalar relativePermeability_

private

Definition at line 62 of file magnet.H.

Referenced by magnet::mur(), Foam::operator<<(), and Foam::operator>>().

remanence_

dimensionedScalar remanence_

private

Definition at line 63 of file magnet.H.

Referenced by magnet::Mr(), Foam::operator<<(), and Foam::operator>>().

orientation_

vector orientation_

private

Definition at line 64 of file magnet.H.

Referenced by Foam::operator<<(), Foam::operator>>(), and magnet::orientation().

---

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

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