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 ()
 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 wordname () const
 Return name. More...
 
scalar mur () const
 Return relative permeability. More...
 
const dimensionedScalarMr () const
 Return remanence. More...
 
const vectororientation () const
 Return orientation. More...
 

Friends

Istreamoperator>> (Istream &is, magnet &m)
 
Ostreamoperator<< (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

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.

◆ mur()

scalar mur ( ) const
inline

Return relative permeability.

Definition at line 111 of file magnet.H.

◆ Mr()

const dimensionedScalar& Mr ( ) const
inline

Return remanence.

Definition at line 117 of file magnet.H.

◆ orientation()

const vector& orientation ( ) const
inline

Return orientation.

Definition at line 123 of file magnet.H.

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.


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