GetVelocityVector Struct Reference

#include <GetVelocity.H>

Public Member Functions
	GetVelocityVector (VelocityProperties const &vel) noexcept
	Construct the functor with information provided by vel.
AMREX_GPU_HOST_DEVICE amrex::XDim3	operator() (amrex::Real const x, amrex::Real const y, amrex::Real const z) const noexcept
	Functor call. Returns the value of velocity at the location (x,y,z).

Public Attributes
VelocityInitType	m_type
amrex::Real	m_ux_mean {0}
amrex::Real	m_uy_mean {0}
amrex::Real	m_uz_mean {0}
amrex::ParserExecutor< 3 >	m_ux_mean_parser
amrex::ParserExecutor< 3 >	m_uy_mean_parser
amrex::ParserExecutor< 3 >	m_uz_mean_parser

Detailed Description

Get the bulk drift momentum vector at a point on the grid

Class to get the bulk drift momentum vector (ux_mean, uy_mean, uz_mean) at a point on the grid, either constant or a spatially varying value computed using parser functions. It provides the velocity information held by the VelocityProperties instance passed to the constructor, and is used by both the Maxwellian and Maxwell-Juttner distributions.

Constructor & Destructor Documentation

GetVelocityVector()

GetVelocityVector::GetVelocityVector ( VelocityProperties const & vel )

explicitnoexcept

Construct the functor with information provided by vel.

Parameters

[in]

vel

const reference to the VelocityProperties object that will be used to populate the functor

Member Function Documentation

operator()()

AMREX_GPU_HOST_DEVICE amrex::XDim3 GetVelocityVector::operator() ( amrex::Real const x, amrex::Real const y, amrex::Real const z ) const

inlinenoexcept

Functor call. Returns the value of velocity at the location (x,y,z).

Parameters

[in]	x	x-coordinate of given location
[in]	y	y-coordinate of given location
[in]	z	z-cooridnate of given location

Returns

value of velocity at (x,y,z). m_ux_mean, m_uy_mean, m_uz_mean if m_type is VelConstantVector m_ux_mean_parser(x,y,z), m_uy_mean_parser(x,y,z), m_uz_mean_parser(x,y,z) if m_type is VelParserFunctionVector

Member Data Documentation

m_type

VelocityInitType GetVelocityVector::m_type

m_ux_mean

amrex::Real GetVelocityVector::m_ux_mean {0}

Constant velocity value, if m_type == VelConstantVector

m_ux_mean_parser

amrex::ParserExecutor<3> GetVelocityVector::m_ux_mean_parser

Velocity parser function, if m_type == VelParserFunctionVector

m_uy_mean

amrex::Real GetVelocityVector::m_uy_mean {0}

m_uy_mean_parser

amrex::ParserExecutor<3> GetVelocityVector::m_uy_mean_parser

m_uz_mean

amrex::Real GetVelocityVector::m_uz_mean {0}

m_uz_mean_parser

amrex::ParserExecutor<3> GetVelocityVector::m_uz_mean_parser

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.07/Source/Initialization/GetVelocity.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.07/Source/Initialization/GetVelocity.cpp