ippl::Maxwell< EMField, SourceField > Class Template Reference

#include <Maxwell.h>

Inheritance diagram for ippl::Maxwell< EMField, SourceField >:

Collaboration diagram for ippl::Maxwell< EMField, SourceField >:

Public Member Functions
	Maxwell ()
	Maxwell (SourceField &four_current, EMField &E, EMField &B)
virtual void	setSources (SourceField &four_current)
void	setEMFields (EMField &E, EMField &B)
void	mergeParameters (const ParameterList &params)
virtual void	solve ()=0
virtual	~Maxwell ()

Static Public Attributes
static constexpr unsigned	Dim = EMField::dim

Protected Attributes
ParameterList	params_m
SourceField *	JN_mp = nullptr
EMField *	En_mp = nullptr
EMField *	Bn_mp = nullptr

Detailed Description

template<typename EMField, typename SourceField>
class ippl::Maxwell< EMField, SourceField >

Definition at line 20 of file Maxwell.h.

Constructor & Destructor Documentation

Maxwell() [1/2]

template<typename EMField, typename SourceField>

ippl::Maxwell< EMField, SourceField >::Maxwell ( )

inline

Default constructor for Maxwell solvers;

Definition at line 27 of file Maxwell.h.

Maxwell() [2/2]

template<typename EMField, typename SourceField>

ippl::Maxwell< EMField, SourceField >::Maxwell ( SourceField & four_current, EMField & E, EMField & B )

inline

Constructor which allows to initialize the field pointers (J, E, B) in the Maxwell solvers class

Parameters

four_current	The four current field (rho, J)
E	The electric field
B	The magnetic field

Definition at line 36 of file Maxwell.h.

~Maxwell()

template<typename EMField, typename SourceField>

virtual ippl::Maxwell< EMField, SourceField >::~Maxwell ( )

inlinevirtual

Definition at line 70 of file Maxwell.h.

Member Function Documentation

mergeParameters()

template<typename EMField, typename SourceField>

void ippl::Maxwell< EMField, SourceField >::mergeParameters ( const ParameterList & params )

inline

Merges another parameter set into the solver's parameters, overwriting existing parameters in case of conflict

Parameters

params

Parameter list with desired values

Definition at line 63 of file Maxwell.h.

setEMFields()

template<typename EMField, typename SourceField>

void ippl::Maxwell< EMField, SourceField >::setEMFields ( EMField & E, EMField & B )

inline

Set the problem LHS (electromagnetic fields)

Parameters

E	The electric field
B	The magnetic field

Definition at line 52 of file Maxwell.h.

Referenced by ippl::FDTDSolverBase< EMField, SourceField, boundary_conditions >::FDTDSolverBase(), and ippl::Maxwell< FieldType, FieldType >::Maxwell().

Here is the caller graph for this function:

setSources()

template<typename EMField, typename SourceField>

virtual void ippl::Maxwell< EMField, SourceField >::setSources ( SourceField & four_current )

inlinevirtual

Set the problem RHS (charge & current densities)

Parameters

four_current

The four current field (rho, J)

Definition at line 45 of file Maxwell.h.

Referenced by ippl::FDTDSolverBase< EMField, SourceField, boundary_conditions >::FDTDSolverBase(), and ippl::Maxwell< FieldType, FieldType >::Maxwell().

Here is the caller graph for this function:

solve()

template<typename EMField, typename SourceField>

virtual void ippl::Maxwell< EMField, SourceField >::solve ( )

pure virtual

Solve the electromagnetic problem (Maxwell's eqs)

Implemented in ippl::FDTDSolverBase< EMField, SourceField, boundary_conditions >, ippl::FDTDSolverBase< EMField, SourceField, periodic >, and ippl::FEMMaxwellDiffusionSolver< FieldType >.

Member Data Documentation

Bn_mp

template<typename EMField, typename SourceField>

EMField* ippl::Maxwell< EMField, SourceField >::Bn_mp = nullptr

protected

Definition at line 81 of file Maxwell.h.

Referenced by ippl::FDTDSolverBase< EMField, SourceField, boundary_conditions >::evaluate_EB().

Dim

template<typename EMField, typename SourceField>

unsigned ippl::Maxwell< EMField, SourceField >::Dim = EMField::dim

staticconstexpr

Definition at line 22 of file Maxwell.h.

En_mp

template<typename EMField, typename SourceField>

EMField* ippl::Maxwell< EMField, SourceField >::En_mp = nullptr

protected

Definition at line 80 of file Maxwell.h.

Referenced by ippl::FDTDSolverBase< EMField, SourceField, boundary_conditions >::evaluate_EB().

JN_mp

template<typename EMField, typename SourceField>

SourceField* ippl::Maxwell< EMField, SourceField >::JN_mp = nullptr

protected

Definition at line 77 of file Maxwell.h.

Referenced by ippl::FDTDSolverBase< EMField, SourceField, boundary_conditions >::evaluate_EB(), ippl::NonStandardFDTDSolver< EMField, SourceField, boundary_conditions >::step(), and ippl::StandardFDTDSolver< EMField, SourceField, boundary_conditions >::step().

params_m

template<typename EMField, typename SourceField>

ParameterList ippl::Maxwell< EMField, SourceField >::params_m

protected

Definition at line 74 of file Maxwell.h.

---

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

• Maxwell.h