FEMSuite
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Medium Class Reference

This class models a medium More...

#include <Medium.h>

Collaboration diagram for Medium:
Collaboration graph
[legend]

Public Member Functions

Wavelength GetWavelength () const
 
void SetWavelength (const Wavelength w)
 
Polator GetNextPolator () const
 
void SetNextPolator (const Polator &np)
 
virtual std::string GetName () const
 
virtual void SetName (const std::string name)
 
virtual bool IsReference () const
 Indicates that the actual value of this medium should be retrieved from the media manager. More...
 
virtual void MakeReference (const bool mr=true)
 
virtual ElectronDensity GetElectronDensity () const
 
virtual void SetElectronDensity (const ElectronDensity ed)
 
virtual Conductance GetConductance () const
 
virtual void SetConductance (const Conductance c)
 
virtual double GetEffectiveMassCoeff () const
 
virtual void SetEffectiveMassCoeff (const double e)
 
virtual RelativePermittivity GetRelativePermittivity (const AngularFrequency angularFrequency, const size_t i, const size_t j)
 Calculates the frequency domain relative permittivity More...
 
virtual RelativePermittivity GetRelativePermittivity (const AngularFrequency angularFrequency=psFREQUENCY_ANY) const
 
virtual Permittivity GetPermittivity (const AngularFrequency angularFrequency, const size_t i, const size_t j) const
 Calculates the frequency domain permittivity More...
 
virtual Permittivity GetPermittivity (const AngularFrequency angularFrequency) const
 This incorporates the drude model into the calculations. More...
 
virtual void SetRelativePermittivity (const RelativePermittivity pr)
 
virtual void SetPermittivity (const Permittivity p)
 
virtual RelativePermeability GetRelativePermeability (const AngularFrequency omega, const size_t i, const size_t j) const
 Calculates the relative permeability More...
 
virtual RelativePermeability GetRelativePermeability () const
 
virtual Permeability GetPermeability (const AngularFrequency, const size_t i, const size_t j) const
 Returns the permeability More...
 
virtual Permeability GetPermeability () const
 Returns the isotropic More...
 
void SetRelativePermeability (const RelativePermeability pr)
 
void SetPermeability (const Permeability p)
 
virtual AngularFrequency CalculatePlasmaFrequency () const
 Calculates the plasma frequency for this particular medium More...
 
virtual std::string GetRemarks () const
 
virtual void SetRemarks (const std::string &r)
 
virtual Color GetColor () const
 
virtual void SetColor (const Color &c)
 

Static Public Member Functions

static Medium Zero ()
 This is not meant to be a comprehensive collection of materials; this should be provided by the MediaManager class. This provide a few Medium instances to help with various media operators. More...
 

Protected Attributes

Wavelength m_Wavelength
 Wavelength associated with this entry. More...
 
Polator m_NextPolator
 This specifies the polator repsonsible for the next segment More...
 
std::string m_Remarks
 
Color m_Color
 

Detailed Description

This class models a medium

Member Function Documentation

AngularFrequency Medium::CalculatePlasmaFrequency ( ) const
virtual

Calculates the plasma frequency for this particular medium

virtual Permeability Medium::GetPermeability ( const AngularFrequency  ,
const size_t  i,
const size_t  j 
) const
inlinevirtual

Returns the permeability

virtual Permeability Medium::GetPermeability ( ) const
inlinevirtual

Returns the isotropic

virtual Permittivity Medium::GetPermittivity ( const AngularFrequency  angularFrequency,
const size_t  i,
const size_t  j 
) const
inlinevirtual

Calculates the frequency domain permittivity

Parameters
Angular FrequencyAngular frequency at which the permittivity will be calculated
virtual Permittivity Medium::GetPermittivity ( const AngularFrequency  angularFrequency) const
inlinevirtual

This incorporates the drude model into the calculations.

virtual RelativePermeability Medium::GetRelativePermeability ( const AngularFrequency  omega,
const size_t  i,
const size_t  j 
) const
inlinevirtual

Calculates the relative permeability

virtual RelativePermittivity Medium::GetRelativePermittivity ( const AngularFrequency  angularFrequency,
const size_t  i,
const size_t  j 
)
inlinevirtual

Calculates the frequency domain relative permittivity

Parameters
Angular FrequencyAngular frequency at which the permittivity will be calculated
virtual bool Medium::IsReference ( ) const
inlinevirtual

Indicates that the actual value of this medium should be retrieved from the media manager.

Medium Medium::Zero ( )
static

This is not meant to be a comprehensive collection of materials; this should be provided by the MediaManager class. This provide a few Medium instances to help with various media operators.

This provides an instance of the class that returns a zero for every method. being an easy start point for averaging multiple media

Member Data Documentation

Polator Medium::m_NextPolator
protected

This specifies the polator repsonsible for the next segment

Arithmetic operators on Medium objects are always linear

Wavelength Medium::m_Wavelength
protected

Wavelength associated with this entry.

This entry could be used to automate dispersion calculations


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