ARTEMIS
Public Member Functions | Public Attributes | Private Attributes | List of all members
MacroscopicProperties Class Reference

This class contains the macroscopic properties of the medium needed to evaluate macroscopic Maxwell equation. More...

#include <MacroscopicProperties.H>

Public Member Functions

 MacroscopicProperties ()
 
void ReadParameters ()
 
void InitData ()
 
amrex::MultiFab & getsigma_mf ()
 
amrex::MultiFab * get_pointer_sigma ()
 
amrex::MultiFab & getepsilon_mf ()
 
amrex::MultiFab * get_pointer_eps ()
 
amrex::MultiFab & getmu_mf ()
 
amrex::MultiFab * get_pointer_mu ()
 
void InitializeMacroMultiFabUsingParser (amrex::MultiFab *macro_mf, amrex::ParserExecutor< 3 > const &macro_parser, const int lev)
 
void InitializeMacroMultiFabFromNumpy (amrex::MultiFab *macro_mf, const std::string &npy_filename, const int lev, const int npy_k_index, const amrex::Real npy_value)
 
void InitializePECFromSigma (amrex::MultiFab *sigma_mf, amrex::MultiFab *PECx, amrex::MultiFab *PECy, const int npy_k_index)
 

Public Attributes

amrex::GpuArray< int, 3 > macro_cr_ratio
 
amrex::GpuArray< int, 3 > sigma_IndexType
 
amrex::GpuArray< int, 3 > epsilon_IndexType
 
amrex::GpuArray< int, 3 > mu_IndexType
 
amrex::GpuArray< int, 3 > Ex_IndexType
 
amrex::GpuArray< int, 3 > Ey_IndexType
 
amrex::GpuArray< int, 3 > Ez_IndexType
 
amrex::GpuArray< int, 3 > Bx_IndexType
 
amrex::GpuArray< int, 3 > By_IndexType
 
amrex::GpuArray< int, 3 > Bz_IndexType
 
std::string m_sigma_s = "constant"
 
std::string m_epsilon_s = "constant"
 
std::string m_mu_s = "constant"
 
amrex::Real m_sigma = 0.0
 
amrex::Real m_epsilon = PhysConst::ep0
 
amrex::Real m_mu = PhysConst::mu0
 
int m_npy_k_index = 0
 
std::string m_sigma_npy_filename
 
std::string m_epsilon_npy_filename
 
std::string m_mu_npy_filename
 
amrex::Real m_sigma_npy_value = 0.
 
amrex::Real m_epsilon_npy_value = 0.
 
amrex::Real m_mu_npy_value = 0.
 
std::unique_ptr< amrex::Parser > m_sigma_parser
 
std::unique_ptr< amrex::Parser > m_epsilon_parser
 
std::unique_ptr< amrex::Parser > m_mu_parser
 

Private Attributes

std::unique_ptr< amrex::MultiFab > m_sigma_mf
 
std::unique_ptr< amrex::MultiFab > m_eps_mf
 
std::unique_ptr< amrex::MultiFab > m_mu_mf
 
std::string m_str_sigma_function
 
std::string m_str_epsilon_function
 
std::string m_str_mu_function
 

Detailed Description

This class contains the macroscopic properties of the medium needed to evaluate macroscopic Maxwell equation.

Constructor & Destructor Documentation

◆ MacroscopicProperties()

MacroscopicProperties::MacroscopicProperties ( )

Member Function Documentation

◆ get_pointer_eps()

amrex::MultiFab* MacroscopicProperties::get_pointer_eps ( )
inline

◆ get_pointer_mu()

amrex::MultiFab* MacroscopicProperties::get_pointer_mu ( )
inline

◆ get_pointer_sigma()

amrex::MultiFab* MacroscopicProperties::get_pointer_sigma ( )
inline

◆ getepsilon_mf()

amrex::MultiFab& MacroscopicProperties::getepsilon_mf ( )
inline

return MultiFab, epsilon (permittivity) of the medium.

◆ getmu_mf()

amrex::MultiFab& MacroscopicProperties::getmu_mf ( )
inline

return MultiFab, mu (permeability) of the medium.

◆ getsigma_mf()

amrex::MultiFab& MacroscopicProperties::getsigma_mf ( )
inline

return MultiFab, sigma (conductivity) of the medium.

◆ InitData()

void MacroscopicProperties::InitData ( )

Initialize multifabs storing macroscopic multifabs

◆ InitializeMacroMultiFabFromNumpy()

void MacroscopicProperties::InitializeMacroMultiFabFromNumpy ( amrex::MultiFab *  macro_mf,
const std::string &  npy_filename,
const int  lev,
const int  npy_k_index,
const amrex::Real  npy_value 
)

◆ InitializeMacroMultiFabUsingParser()

void MacroscopicProperties::InitializeMacroMultiFabUsingParser ( amrex::MultiFab *  macro_mf,
amrex::ParserExecutor< 3 > const &  macro_parser,
const int  lev 
)

Initializes the Multifabs storing macroscopic properties with user-defined functions(x,y,z).

◆ InitializePECFromSigma()

void MacroscopicProperties::InitializePECFromSigma ( amrex::MultiFab *  sigma_mf,
amrex::MultiFab *  PECx,
amrex::MultiFab *  PECy,
const int  npy_k_index 
)

◆ ReadParameters()

void MacroscopicProperties::ReadParameters ( )

Read user-defined macroscopic properties. Called in constructor.

Member Data Documentation

◆ Bx_IndexType

amrex::GpuArray<int, 3> MacroscopicProperties::Bx_IndexType

Gpu Vector with index type of the Bx multifab

◆ By_IndexType

amrex::GpuArray<int, 3> MacroscopicProperties::By_IndexType

Gpu Vector with index type of the By multifab

◆ Bz_IndexType

amrex::GpuArray<int, 3> MacroscopicProperties::Bz_IndexType

Gpu Vector with index type of the Bz multifab

◆ epsilon_IndexType

amrex::GpuArray<int, 3> MacroscopicProperties::epsilon_IndexType

Gpu Vector with index type of the permittivity multifab

◆ Ex_IndexType

amrex::GpuArray<int, 3> MacroscopicProperties::Ex_IndexType

Gpu Vector with index type of the Ex multifab

◆ Ey_IndexType

amrex::GpuArray<int, 3> MacroscopicProperties::Ey_IndexType

Gpu Vector with index type of the Ey multifab

◆ Ez_IndexType

amrex::GpuArray<int, 3> MacroscopicProperties::Ez_IndexType

Gpu Vector with index type of the Ez multifab

◆ m_eps_mf

std::unique_ptr<amrex::MultiFab> MacroscopicProperties::m_eps_mf
private

Multifab for m_epsilon

◆ m_epsilon

amrex::Real MacroscopicProperties::m_epsilon = PhysConst::ep0

Permittivity, epsilon, of the medium

◆ m_epsilon_npy_filename

std::string MacroscopicProperties::m_epsilon_npy_filename

◆ m_epsilon_npy_value

amrex::Real MacroscopicProperties::m_epsilon_npy_value = 0.

◆ m_epsilon_parser

std::unique_ptr<amrex::Parser> MacroscopicProperties::m_epsilon_parser

◆ m_epsilon_s

std::string MacroscopicProperties::m_epsilon_s = "constant"

Stores initialization type for permittivity : constant or parser

◆ m_mu

amrex::Real MacroscopicProperties::m_mu = PhysConst::mu0

Permeability, mu, of the medium

◆ m_mu_mf

std::unique_ptr<amrex::MultiFab> MacroscopicProperties::m_mu_mf
private

Multifab for m_mu

◆ m_mu_npy_filename

std::string MacroscopicProperties::m_mu_npy_filename

◆ m_mu_npy_value

amrex::Real MacroscopicProperties::m_mu_npy_value = 0.

◆ m_mu_parser

std::unique_ptr<amrex::Parser> MacroscopicProperties::m_mu_parser

◆ m_mu_s

std::string MacroscopicProperties::m_mu_s = "constant"

Stores initialization type for permeability : constant or parser

◆ m_npy_k_index

int MacroscopicProperties::m_npy_k_index = 0

index to insert the mask

◆ m_sigma

amrex::Real MacroscopicProperties::m_sigma = 0.0

Conductivity, sigma, of the medium

◆ m_sigma_mf

std::unique_ptr<amrex::MultiFab> MacroscopicProperties::m_sigma_mf
private

Multifab for m_sigma

◆ m_sigma_npy_filename

std::string MacroscopicProperties::m_sigma_npy_filename

numpy arrays for layer

◆ m_sigma_npy_value

amrex::Real MacroscopicProperties::m_sigma_npy_value = 0.

numerical value of sigma, epsilon, and mu for gds numpy array layer

◆ m_sigma_parser

std::unique_ptr<amrex::Parser> MacroscopicProperties::m_sigma_parser

Parser Wrappers

◆ m_sigma_s

std::string MacroscopicProperties::m_sigma_s = "constant"

Stores initialization type for conductivity : constant or parser

◆ m_str_epsilon_function

std::string MacroscopicProperties::m_str_epsilon_function
private

◆ m_str_mu_function

std::string MacroscopicProperties::m_str_mu_function
private

◆ m_str_sigma_function

std::string MacroscopicProperties::m_str_sigma_function
private

string for storing parser function

◆ macro_cr_ratio

amrex::GpuArray<int, 3> MacroscopicProperties::macro_cr_ratio

Gpu Vector with index type of coarsening ratio with default value (1,1,1)

◆ mu_IndexType

amrex::GpuArray<int, 3> MacroscopicProperties::mu_IndexType

Gpu Vector with index type of the permeability multifab

◆ sigma_IndexType

amrex::GpuArray<int, 3> MacroscopicProperties::sigma_IndexType

Gpu Vector with index type of the conductivity multifab

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.1