Maxwellian Fluid Model

MaxwellianFluidModel

class pyphare.pharein.MaxwellianFluidModel(bx=None, by=None, bz=None, **kwargs)[source]

MaxwellianFluidModel is used to setup ion populations in a simulation along with the magnetic field.

Usage example:

ph.MaxwellianFluidModel(
    bx=bx,
    by=by,
    bz=bz,
    protons={"charge": 1,
             "density": density,
             "vbulkx": vx,
             "vbulky": vy,
             "vbulkz": vz,
             "vthx": vthx,
             "vthy": vthy,
             "vthz": vthz,
             "nbr_part_per_cell": 100},

    beam={"charge": 1,
             "density": beam_density,
             "vbulkx": vx_beam,
             "vbulky": vy_beam,
             "vbulkz": vz_beam,
             "vthx": vthx_beam,
             "vthy": vthy_beam,
             "vthz": vthz_beam,
             "nbr_part_per_cell": 500}
)

Parameters:

  • bx (function): magnetic field in x direction

  • by (function): magnetic field in y direction

  • bz (function): magnetic field in z direction

add_population(name, charge=1.0, mass=1.0, nbr_part_per_cell=100, density=None, vbulkx=None, vbulky=None, vbulkz=None, vthx=None, vthy=None, vthz=None, init={}, density_cut_off=1e-16)[source]

add a particle population to the current model

add_population(name,charge=1, mass=1, nbrPartCell=100, density=1, vbulk=(0,0,0), beta=1, anisotropy=1)

Parameters

name : name of the species, str

Other Parameters

charge : charge of the species particles, float (default = 1.) nbrPartCell : number of particles per cell, int (default = 100) density : particle density, float (default = 1.) vbulk : bulk velocity, tuple of size 3 (default = (0,0,0)) beta : beta of the species, float (default = 1) anisotropy : Pperp/Ppara of the species, float (default = 1)

nbr_populations()[source]

returns the number of species currently registered in the model