Dielectric Class Reference

dielectric class. Simple tuple. More...

#include <CD_Dielectric.H>

Public Member Functions
	Dielectric ()
	Weak constructor, must subsequently call one of the define methods.
	Dielectric (const RefCountedPtr< BaseIF > &a_baseIF, const Real a_permittivity)
	Full constructor which uses constant permittivity.
	Dielectric (const RefCountedPtr< BaseIF > &a_baseIF, const std::function< Real(const RealVect a_pos)> &a_permittivity)
	Full constructor which uses variable permittivity.
virtual	~Dielectric ()
	Destructor (does nothing).
virtual void	define (const RefCountedPtr< BaseIF > &a_baseIF, const Real a_permittivity)
	Define function.
virtual void	define (const RefCountedPtr< BaseIF > &a_baseIF, const std::function< Real(const RealVect a_pos)> &a_permittivity)
	Define function for variable permittivity.
virtual const RefCountedPtr< BaseIF > &	getImplicitFunction () const
	Get level-set function.
virtual Real	getPermittivity (const RealVect &a_pos) const
	Get permittivity.

Protected Attributes
RefCountedPtr< BaseIF >	m_baseIF
	Implicit function.
Real	m_constantPermittivity
	Constant permittivity.
std::function< Real(const RealVect a_pos)>	m_variablePermittivity
	Variable permittivity.
bool	m_useConstant
	Use constant permittivity or not.
bool	m_isDefined
	Is defined or not.

Detailed Description

dielectric class. Simple tuple.

Constructor & Destructor Documentation

Dielectric() [1/2]

Dielectric::Dielectric	(	const RefCountedPtr< BaseIF > &	a_baseIF,
		const Real	a_permittivity
	)

Full constructor which uses constant permittivity.

Parameters

[in]	a_baseIF	Implicit function
[in]	a_permittivity	Constant permittivity

Note

Calls the define function for constant permittivity.

Dielectric() [2/2]

Dielectric::Dielectric	(	const RefCountedPtr< BaseIF > &	a_baseIF,
		const std::function< Real(const RealVect a_pos)> &	a_permittivity
	)

Full constructor which uses variable permittivity.

Parameters

[in]	a_baseIF	Implicit function
[in]	a_permittivity	Variable permittivity

Note

Calls the define function for variable permittivity.

Member Function Documentation

define() [1/2]

void Dielectric::define ( const RefCountedPtr< BaseIF > &  a_baseIF, const Real  a_permittivity  )

virtual

Define function.

Parameters

[in]	a_baseIF	Implicit function
[in]	a_permittivity	Constant permittivity

define() [2/2]

void Dielectric::define ( const RefCountedPtr< BaseIF > &  a_baseIF, const std::function< Real(const RealVect a_pos)> &  a_permittivity  )

virtual

Define function for variable permittivity.

Parameters

[in]	a_baseIF	Implicit function
[in]	a_permittivity	Variable permittivity

getImplicitFunction()

const RefCountedPtr< BaseIF > & Dielectric::getImplicitFunction ( ) const

virtual

Get level-set function.

Returns

Returns m_baseIF

getPermittivity()

Real Dielectric::getPermittivity ( const RealVect &  a_pos ) const

virtual

Get permittivity.

Parameters

[in]

a_pos

Position

Returns

Returns permittivity for physical coordinates a_pos.

---

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

• Source/Geometry/CD_Dielectric.H
• Source/Geometry/CD_Dielectric.cpp