VANTAGE-Reactions documentation#
Contents:
- Overview
- Overview
- Marking and transformations
- On-device N-dimensional Linear Interpolation
- Particle property utilities
- Reactions controllers
- Reactions and their components
- User Guide
- Developer Guide
- API Reference
VANTAGE::Reactions::AbstractBinaryArrayTransformVANTAGE::Reactions::AbstractCrossSectionVANTAGE::Reactions::AbstractDataCalculatorVANTAGE::Reactions::AbstractReactionAbstractReaction()~AbstractReaction()calculate_rates_v()calculate_rates()apply_v()apply()get_in_states()get_out_states()flush_buffer()flush_weight_buffer()flush_pre_req_data()set_max_buffer_size()get_weight_sym()set_weight_sym()get_total_reaction_rate()set_total_reaction_rate()get_device_rate_buffer()get_device_weight_buffer()set_device_weight_buffer()get_device_rate_buffer_size()set_device_rate_buffer()get_sycl_target()get_pre_req_data()set_pre_req_data()get_max_buffer_size()total_reaction_ratedevice_rate_bufferdevice_weight_buffersycl_target_storedpre_req_dataweight_symmax_buffer_size
VANTAGE::Reactions::AbstractUnaryArrayTransformVANTAGE::Reactions::AMJUEL1DDataVANTAGE::Reactions::AMJUEL1DDataOnDeviceVANTAGE::Reactions::AMJUEL2DDataVANTAGE::Reactions::AMJUEL2DDataH3VANTAGE::Reactions::AMJUEL2DDataH3OnDeviceVANTAGE::Reactions::AMJUEL2DDataOnDeviceVANTAGE::Reactions::AMJUELFitCrossSectionVANTAGE::Reactions::ArgumentNameSetVANTAGE::Reactions::ArrayLookupDataVANTAGE::Reactions::ArrayLookupDataOnDeviceVANTAGE::Reactions::ArrheniusDataVANTAGE::Reactions::ArrheniusDataOnDeviceVANTAGE::Reactions::BinaryArrayOperatorTransformVANTAGE::Reactions::BinaryArrayTransformDataVANTAGE::Reactions::BinaryArrayTransformDataOnDeviceVANTAGE::Reactions::BinaryDotArrayTransformVANTAGE::Reactions::BinaryElementwiseOperatorTransformVANTAGE::Reactions::BinaryProjectArrayTransformVANTAGE::Reactions::BinaryProjectNormalArrayTransformVANTAGE::Reactions::CartesianBasisReflectionDataVANTAGE::Reactions::CartesianBasisReflectionDataOnDeviceVANTAGE::Reactions::CartesianGridDataVANTAGE::Reactions::CartesianGridDataOnDeviceVANTAGE::Reactions::CellwiseAccumulatorVANTAGE::Reactions::CellwiseDistributorVANTAGE::Reactions::CellwiseReactionDataAccumulatorVANTAGE::Reactions::CompositeDataVANTAGE::Reactions::CompositeDataOnDeviceVANTAGE::Reactions::CompositeTransformVANTAGE::Reactions::ConcatenatorDataVANTAGE::Reactions::ConcatenatorDataOnDeviceVANTAGE::Reactions::ConstantRateCrossSectionVANTAGE::Reactions::CXReactionKernelsVANTAGE::Reactions::CXReactionKernelsOnDeviceCXReactionKernelsOnDevice()scattering_kernel()weight_kernel()transformation_kernel()feedback_kernel()velocity_indprojectile_source_density_indprojectile_source_energy_indprojectile_source_momentum_indtarget_source_density_indtarget_source_momentum_indtarget_source_energy_indweight_inddescendant_internal_state_inddescendant_velocity_inddescendant_weight_indtarget_massprojectile_mass
VANTAGE::Reactions::DataCalculatorVANTAGE::Reactions::DownsamplingKernelBaseRNG_TYPEDownsamplingKernelBase()DownsamplingKernelBase()get_required_int_sym_vector()get_required_real_sym_vector()get_downsampling_kernel_on_device()get_reduction_kernel_on_device()pre_calculate()get_rng_kernel()set_rng_kernel()DOWNSAMPLING_MODEDOWNSAMPLING_DIMREDUCTION_PLUS_DIMREDUCTION_MIN_DIMREDUCTION_MAX_DIMTOTAL_REDUCTION_DIMreduction_on_device_objdownsampling_on_device_objrequired_int_propsrequired_real_propsproperties_maprng_kernel
VANTAGE::Reactions::DownsamplingKernelOnDeviceBaseVANTAGE::Reactions::DownsamplingReductionKernelOnDeviceBaseVANTAGE::Reactions::DownsamplingStrategyVANTAGE::Reactions::ElectronImpactIonisationVANTAGE::Reactions::ExtractorDataVANTAGE::Reactions::ExtractorDataOnDeviceVANTAGE::Reactions::FilteredMaxwellianOnDeviceVANTAGE::Reactions::FilteredMaxwellianSamplerVANTAGE::Reactions::FixedArrayDataVANTAGE::Reactions::FixedArrayDataOnDeviceVANTAGE::Reactions::FixedCoefficientDataVANTAGE::Reactions::FixedCoefficientDataOnDeviceVANTAGE::Reactions::FixedRateDataVANTAGE::Reactions::FixedRateDataOnDeviceVANTAGE::Reactions::GeneralAbsorptionKernelsVANTAGE::Reactions::GeneralAbsorptionKernelsOnDeviceVANTAGE::Reactions::GridDescriptorVANTAGE::Reactions::InterpolateDataVANTAGE::Reactions::InterpolateDataOnDeviceInterpolateDataOnDevice()InterpolateDataOnDevice()calc_data()d_hypercube_vertices_ptrd_dims_vec_ptrd_coords_vec_ptrd_extended_coords_vec_ptrd_extended_dims_vec_ptrd_coords_strides_ptrd_extended_coords_strides_ptrinterp_indicesnon_interp_indicescontinue_linearclamp_to_zeroclamp_to_edgeinitial_num_pointstotal_ndim
VANTAGE::Reactions::IoniseReactionKernelsVANTAGE::Reactions::IoniseReactionKernelsOnDeviceVANTAGE::Reactions::grid_utils::is_std_array_of_realVANTAGE::Reactions::grid_utils::is_std_array_of_real< std::array< REAL, N > >VANTAGE::Reactions::utils::LambdaWrapperVANTAGE::Reactions::LinearReactionBaseVANTAGE::Reactions::LinearReactionBaseImplLinearReactionBaseImpl()calculate_rates_v()apply_v()flush_buffer()flush_weight_buffer()blockwise_flush_buffer()flush_pre_req_data()flush_pre_req_data()blockwise_flush_pre_req_data()get_in_states()get_out_states()fill_pre_req_data()~LinearReactionBaseImpl()in_stateout_statesreaction_datareaction_kernelsdescendant_particlescalculate_rates_int_symscalculate_rates_real_symsapply_int_symsapply_real_syms
VANTAGE::Reactions::LinearScatteringKernelsVANTAGE::Reactions::LinearScatteringKernelsOnDeviceVANTAGE::Reactions::MarkingFunctionWrapperBaseVANTAGE::Reactions::MarkingStrategyVANTAGE::Reactions::MarkingStrategyBaseVANTAGE::Reactions::MarkingStrategyDirectVANTAGE::Reactions::MergeTransformationStrategyVANTAGE::Reactions::MinimumNPartInCellMarkerVANTAGE::Reactions::NoOpTransformationStrategyVANTAGE::Reactions::OneWayMaxwellianFluxOnDeviceVANTAGE::Reactions::OneWayMaxwellianFluxSamplerVANTAGE::Reactions::PanickedParticleMarkerVANTAGE::Reactions::ParticleDatZeroerVANTAGE::Reactions::ParticleSpecBuilderVANTAGE::Reactions::PipelineDataVANTAGE::Reactions::PipelineDataOnDeviceVANTAGE::Reactions::PolynomialArrayTransformVANTAGE::Reactions::ProfilingBaseVANTAGE::Reactions::PropertiesProperties()Properties()Properties()Properties()Properties()Properties()Properties()merge_with()simple_prop_names()simple_prop_index()species_prop_names()species_prop_index()get_prop_names()get_simple_props()get_species()get_species_props()get_props()simple_propsspeciesspecies_propsall_props
VANTAGE::Reactions::PropertiesMapVANTAGE::Reactions::ReactionControllerReactionController()ReactionController()ReactionController()ReactionController()controller_pre_process()add_reaction()set_max_particles_per_cell()set_cell_block_size()set_auto_clean_tot_rate_buffer()get_auto_clean_tot_rate_buffer()apply_parent_transforms()apply()apply()set_rng_kernel()get_rng_kernel()apply_parent_transforms_impl()apply_impl()setup_particle_group_temporary()sub_group_selectorsspecies_groupsreacted_species_groupsreference_particle_groupparent_idschild_idsreactionsparent_transformchild_transformreacted_markerid_sympanic_flagreacted_flagtot_rate_bufferweight_symrate_buffer_zeroerauto_clean_tot_rate_bufferrng_kernelcell_block_sizemax_particles_per_cellparticle_group_temporary
VANTAGE::Reactions::ReactionDataBaseVANTAGE::Reactions::ReactionDataBaseImplReactionDataBaseImpl()ReactionDataBaseImpl()ReactionDataBaseImpl()ReactionDataBaseImpl()ReactionDataBaseImpl()get_required_int_props()set_required_int_props()get_required_int_sym_vector()get_required_real_props()get_required_real_sym_vector()set_required_real_props()~ReactionDataBaseImpl()index_on_device_object()required_int_propsrequired_real_propsproperties_map
VANTAGE::Reactions::ReactionDataBaseOnDeviceVANTAGE::Reactions::ReactionKernelsBaseReactionKernelsBase()ReactionKernelsBase()ReactionKernelsBase()ReactionKernelsBase()ReactionKernelsBase()~ReactionKernelsBase()get_required_int_props()get_required_real_props()get_required_int_props_ephemeral()get_required_real_props_ephemeral()get_required_descendant_int_props()get_required_descendant_real_props()get_descendant_matrix_spec()get_pre_ndims()set_required_descendant_int_props()set_required_descendant_real_props()set_descendant_matrix_spec()required_int_propsrequired_real_propsrequired_int_props_ephemeralrequired_real_props_ephemeralrequired_descendant_int_propsrequired_descendant_real_propsdescendant_matrix_specpre_req_ndimsproperties_map
VANTAGE::Reactions::ReactionKernelsBaseOnDeviceVANTAGE::Reactions::RecombinationVANTAGE::Reactions::RecombReactionKernelsVANTAGE::Reactions::RecombReactionKernelsOnDeviceRecombReactionKernelsOnDevice()scattering_kernel()weight_kernel()transformation_kernel()feedback_kernel()weight_indprojectile_source_density_indprojectile_source_energy_indprojectile_source_momentum_indtarget_source_density_indtarget_source_momentum_indtarget_source_energy_inddescendant_internal_state_inddescendant_velocity_inddescendant_weight_indtarget_massnormalised_potential_energy
VANTAGE::Reactions::SamplerDataVANTAGE::Reactions::SamplerDataOnDeviceVANTAGE::Reactions::ScalerArrayTransformVANTAGE::Reactions::SimpleRemovalTransformationStrategyVANTAGE::Reactions::SimpleThinningKernelsVANTAGE::Reactions::SimpleThinningOnDeviceVANTAGE::Reactions::SpeciesVANTAGE::Reactions::SpecularReflectionDataVANTAGE::Reactions::SpecularReflectionDataOnDeviceVANTAGE::Reactions::SpecularReflectionKernelsVANTAGE::Reactions::SpecularReflectionKernelsOnDeviceVANTAGE::Reactions::SphericalBasisReflectionDataVANTAGE::Reactions::SphericalBasisReflectionDataOnDeviceVANTAGE::Reactions::StandardPropertiesEnumStandardPropertyIDreacted_flaggrouping_indexlinear_indexpanicpositionvelocitycell_ididtot_reaction_rateweightinternal_stateboundary_intersection_pointboundary_intersection_normalboundary_intersection_metadatatemperaturedensityflow_speedsource_energysource_momentumsource_densitysurface_basis_e1surface_basis_e2surface_basis_pifluid_densityfluid_temperaturefluid_flow_speed
VANTAGE::Reactions::TransformationStrategyVANTAGE::Reactions::TransformationStrategyDirectVANTAGE::Reactions::TransformationStrategyLambdaVANTAGE::Reactions::TransformationWrapperVANTAGE::Reactions::TrimEvalDataVANTAGE::Reactions::TrimEvalDataOnDeviceVANTAGE::Reactions::UnaryArrayOperatorTransformVANTAGE::Reactions::UnaryArrayTransformDataVANTAGE::Reactions::UnaryArrayTransformDataOnDeviceVANTAGE::Reactions::UnaryElementwiseOperatorTransformVANTAGE::Reactions::UnaryProjectArrayTransformVANTAGE::Reactions::UnaryProjectNormalArrayTransformVANTAGE::Reactions::VranicMergingKernelsVANTAGE::Reactions::VranicMergingOnDeviceVANTAGE::Reactions::VranicReductionOnDeviceVANTAGE::Reactions::WeightedCellwiseAccumulatorstdVANTAGEVANTAGE::ReactionsINTREALDEFAULT_RNG_KERNELcalc_data_return_tDownsamplingModeControllerModeExtrapolationTypepanicked()make_simple_thinning_strategy()get_default_map()map_subset_check()operator==()species_property()operator+()operator*()operator-()operator/()dot_product()scale_by()uatData()uetData()batData()betData()uniform_velocity_bin_transform()get_on_device_objs()total_dim()total_dim()make_vranic_merging_strategy()last_dim()last_dim()first_in_dim()check_consistency()check_consistency()pipe()check_calc_data_return_type()extract()make_marking_strategy()make_transformation_strategy()make_direct_marking_strategy()make_direct_transformation_strategy()make_lambda_transformation_strategy()default_propertiesPROFILING_LEVELis_calc_data_callable_vINF_INTERP_DOUBLE
VANTAGE::Reactions::calc_data_traits_defsVANTAGE::Reactions::grid_utilsVANTAGE::Reactions::interp_utilsVANTAGE::Reactions::utilsNESOASSERT_FUNCTIONneso_particles_test_assert()