IPPL API Reference
Independent Parallel Particle Layer C++ API
Loading...
Searching...
No Matches
ippl::Maxwell< EMField, SourceField > Class Template Referenceabstract
+ 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
 

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
 

Constructor & Destructor Documentation

◆ Maxwell() [1/2]

template<typename EMField , typename SourceField >
ippl::Maxwell< EMField, SourceField >::Maxwell ( )
inline

Default constructor for Maxwell solvers;

◆ 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_currentThe four current field (rho, J)
EThe electric field
BThe magnetic field

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
paramsParameter list with desired values

◆ setEMFields()

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

Set the problem LHS (electromagnetic fields)

Parameters
EThe electric field
BThe magnetic field

◆ 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_currentThe four current field (rho, J)

◆ solve()

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

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