FieldDriverOptions.hh File Reference

#include "corecel/Macros.hh"
#include "corecel/Types.hh"
#include "celeritas/Units.hh"

This graph shows which files directly or indirectly include this file:

Classes
struct	celeritas::FieldDriverOptions
	Configuration options for field propagation and substepping. More...

Functions
constexpr bool	celeritas::operator== (FieldDriverOptions const &a, FieldDriverOptions const &b)
	Equality operator.
void	celeritas::validate_input (FieldDriverOptions const &opts)
	Throw a runtime assertion if any of the input is invalid.

Function Documentation

validate_input()

void celeritas::validate_input

(

FieldDriverOptions const &

opts

)

Throw a runtime assertion if any of the input is invalid.

This should be called when creating "params" or along-step helpers that use the field driver.