Celeritas 0.6.0-rc.2.10+develop.de0a3a05
Loading...
Searching...
No Matches
List of all members
celeritas::UniformFieldParams Class Referencefinal

Construct and store data for a uniform magnetic field. More...

#include <UniformFieldParams.hh>

Inheritance diagram for celeritas::UniformFieldParams:
Inheritance graph
[legend]

Type aliases

using Input = inp::UniformField
 Construct from a user-defined field.
 
 UniformFieldParams (GeoParams const &geo, Input const &inp)
 Construct from a user-defined field.
 
HostRef consthost_ref () const final
 Access field data on the host.
 
DeviceRef constdevice_ref () const final
 Access field data on the device.
 
bool in_all_volumes () const
 Whether the field is present everywhere.
 

Additional Inherited Members

- Public Types inherited from celeritas::ParamsDataInterface< UniformFieldParamsData >
using HostRef = HostCRef< UniformFieldParamsData >
 
using DeviceRef = DeviceCRef< UniformFieldParamsData >
 
- Public Member Functions inherited from celeritas::ParamsDataInterface< UniformFieldParamsData >
UniformFieldParamsData< Ownership::const_reference, M > const & ref () const
 
UniformFieldParamsData< Ownership::const_reference, M > const & ref () const
 Dispatch a "ref" call to host or device data.
 
- Protected Member Functions inherited from celeritas::ParamsDataInterface< UniformFieldParamsData >
 CELER_DEFAULT_COPY_MOVE (ParamsDataInterface)
 

Detailed Description

Construct and store data for a uniform magnetic field.

Member Function Documentation

◆ device_ref()

DeviceRef const & celeritas::UniformFieldParams::device_ref ( ) const
inlinefinalvirtual

Access field data on the device.

Implements celeritas::ParamsDataInterface< UniformFieldParamsData >.

◆ host_ref()

HostRef const & celeritas::UniformFieldParams::host_ref ( ) const
inlinefinalvirtual

Access field data on the host.

Implements celeritas::ParamsDataInterface< UniformFieldParamsData >.


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