magnet Class Reference

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

#include <magnet.H>

Public Member Functions
	magnet ()
	Null constructor for lists.
	magnet (const word &name, const scalar mur, const scalar Mr, const vector &orientation)
	Construct from components.
	magnet (Istream &is)
	Construct from Istream.
const word &	name () const
	Return name.
scalar	mur () const
	Return relative permeability.
const dimensionedScalar &	Mr () const
	Return remenance.
const vector &	orientation () const
	Return 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 51 of file magnet.H.

Constructor & Destructor Documentation

magnet() [1/3]

magnet ( )

inline

Null constructor for lists.

Definition at line 67 of file magnet.H.

References Foam::Zero.

Referenced by operator<<, and operator>>.

Here is the caller graph for this function:

magnet() [2/3]

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

inline

Construct from components.

Definition at line 76 of file magnet.H.

References Mr(), mur(), name(), and orientation().

Here is the call graph for this function:

magnet() [3/3]

magnet ( Istream & is )

inline

Construct from Istream.

Definition at line 93 of file magnet.H.

References Foam::Zero.

Member Function Documentation

name()

const word & name ( ) const

inline

Return name.

Definition at line 107 of file magnet.H.

Referenced by magnet().

Here is the caller graph for this function:

mur()

scalar mur ( ) const

inline

Return relative permeability.

Definition at line 115 of file magnet.H.

Referenced by magnet().

Here is the caller graph for this function:

Mr()

const dimensionedScalar & Mr ( ) const

inline

Return remenance.

Definition at line 123 of file magnet.H.

Referenced by magnet().

Here is the caller graph for this function:

orientation()

const vector & orientation ( ) const

inline

Return orientation.

Definition at line 131 of file magnet.H.

Referenced by magnet().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

operator>>

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

friend

Definition at line 139 of file magnet.H.

References IOstream::check(), FUNCTION_NAME, magnet(), Istream::readBegin(), Istream::readEnd(), and dimensioned< Type >::value().

operator<<

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

friend

Definition at line 152 of file magnet.H.

References token::BEGIN_LIST, token::END_LIST, magnet(), os(), token::SPACE, and dimensioned< Type >::value().

---

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

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