SpECTRE  v2024.09.29
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123456]
 NActionsContains various actions
 NActionTestingStructures used for mocking the parallel components framework in order to test actions
 NahContains utilities for working with apparent horizons
 NamrItems for adaptive mesh refinement
 NblazeCode for interoperating and extending Blaze
 NBnsInitialDataItems related to solving for irrotational Binary Neutron Star initial data
 Nboost
 Nbrigand
 NBurgersItems related to evolving the Burgers equation 0=tU+x(U2/2)
 NCceThe set of utilities for performing Cauchy characteristic evolution and Cauchy characteristic matching
 NCcz4Items related to evolving the first-order CCZ4 system
 Ncontrol_systemControl systems and related functionality
 NConvergenceItems related to checking the convergence of numerical algorithms
 Ncpp20C++ STL code present in C++20
 NCurvedScalarWaveItems related to evolving a scalar wave on a curved background
 NdbNamespace for DataBox related things
 NdeadlockNamespace for actions related to debugging deadlocks in communication
 NDenseTriggersContains denser triggers
 NdgFunctionality related to discontinuous Galerkin schemes
 NDistributedLinearSolverAlgorithmTestHelpersFunctionality to test parallel linear solvers on multiple elements
 Ndo_implicit_step_helpers
 NdomainHolds entities related to the computational domain
 NElasticityItems related to solving elasticity problems
 NellipticItems related to composing nonlinear elliptic solver executables
 NEqualWithinRoundoffImplsSpecializations of EqualWithinRoundoffImpl for custom types, to add support for the equal_within_roundoff function
 NEquationsOfStateContains all equations of state, including base class
 NEvents
 NevolutionFunctionality for evolving hyperbolic partial differential equations
 NFilters
 NForceFreeItems related to evolving the GRFFE system with divergence cleaning
 NFrameIndicates the Frame that a TensorIndexType is in
 NfunclHigher order function objects similar to std::plus, etc
 NghItems related to evolving the first-order generalized harmonic system
 NgrHolds functions related to general relativity
 NgrmhdItems related to general relativistic magnetohydrodynamics (GRMHD)
 NgslImplementations from the Guideline Support Library
 Nh5Contains functions and classes for manipulating HDF5 files
 NhydroItems related to hydrodynamic systems
 NimexCode related to evolution using implicit-explicit time stepping
 NimportersItems related to loading data from files
 NInitialization
 NintegrationNumerical integration algorithms
 NInterpolateOnElementTestHelpersHolds code that is shared between multiple tests. Currently used by
 NInterpTargetTestHelpers
 NintrpContains classes and functions for interpolation
 Nio
 NLimitersThings relating to limiting
 NLinearSolverFunctionality for solving linear systems of equations
 NLinearSolverAlgorithmTestHelpers
 NloggingItems related to logging
 NMakeWithValueImplsImplementations of make_with_value
 NMathFunctionsHolds classes implementing MathFunction (functions RnR)
 Nmem_monitor
 NneutrinosNamespace for neutrino physics
 NNewtonianEulerItems related to evolving the Newtonian Euler system
 NNonlinearSolverFunctionality for solving nonlinear systems of equations
 Nobservers
 NOptionsUtilities for parsing input files
 NOptionTags
 NParallelFunctionality for parallelization
 NParticles
 NPhaseControlContains utilities for determining control-flow among phases
 NPoissonItems related to solving a Poisson equation Δu(x)=f(x)
 Npretty_typeContains all functions that are part of PrettyType, used for printing types in a pretty manner
 Nprotocols
 NPuncturesItems related to solving the puncture equation
 NpyppContains all functions for calling python from C++
 NRadiationTransportItems related to general relativistic radiation transport
 NRegistrationHelpers for derived class registration
 NRelativisticEulerItems related to evolving the relativistic Euler system
 NResidualMonitorActionsTestHelpers
 NRootFinder
 NScalarAdvectionItems related to evolving the scalar advection equation
 NScalarTensorItems related to evolving the first-order scalar tensor system
 NScalarWaveItems related to evolving the scalar wave equation
 NSelfStartDefinition of the integrator self-starting procedure
 NSetNumberOfGridPointsImplsImplementations of set_number_of_grid_points
 NsgbItems related to solving the sGB scalar equation
 Nsimd
 NSpatialDiscretization
 NSpectralFunctionality associated with a particular choice of basis functions and quadrature for spectral operations
 Nspectre
 NStepChoosersHolds all the StepChoosers
 NStf
 Nstl_boilerplateClasses to generate repetitive code needed for STL compatibility
 NTags
 Ntenex
 NTensorMetafunctionsContains all metafunctions related to Tensor manipulations
 NTestHelpersCollection of classes and functions useful for testing
 NTimeSequencesHolds all the TimeSequences
 NTimeSteppersHolds classes that take time steps
 Ntmpl2Metaprogramming things that are not planned to be submitted to Brigand
 NtransformHolds functions related to transforming between frames
 NTriggersContains the available triggers
 NttA collection of useful type traits
 NtuplesContains utilities for working with tuples
 NVariableFixingContains all variable fixers
 NvariantsTaggedVariant and related functionality
 NXctsItems related to solving the Extended Conformal Thin Sandwich (XCTS) decomposition of the Einstein constraint equations
 NylmItems related to spherical harmonics
 NYlmTestFunctions
 CAdaptiveSteppingDiagnostics
 CAlgorithmArrayA Spectre algorithm object that wraps a charm++ array chare
 CAlgorithmGroupA Spectre algorithm object that wraps a charm++ group chare
 CAlgorithmNodegroupA Spectre algorithm object that wraps a charm++ nodegroup chare
 CAlgorithmSingletonA Spectre algorithm object that wraps a single element charm++ array chare
 CAllStepChoosersA placeholder type to indicate that all constructible step choosers should be used in step chooser utilities that permit a list of choosers to be specified
 CAlwaysReadyPostprocessorA wrapper adding an always-true is_ready function for a RunEventsAndDenseTriggers postprocessor. This allows structs designed as mutate_apply arguments to be used without modification
 CApproximateTimeTime-like interface to a double for use with dense output
 CApproximateTimeDeltaTimeDelta-like interface to a double for use with dense output
 CAveragerA weighted exponential averager of Q and its derivatives implementing Appendix A in [91]
 CBinaryTrajectoriesClass to compute post-Newtonian trajectories
 CBlockA Block<VolumeDim> is a region of a VolumeDim-dimensional computational domain that defines the root node of a tree which is used to construct the Elements that cover a region of the computational domain
 CBlockNeighborInformation about the neighbor of a host Block in a particular direction
 CBondiSachs
 CCachedFunctionA function wrapper that caches function values
 CCachedTempBuffer
 CCacheEnumerationPossible enumeration values for the StaticCache. Only values specified here are retrievable
 CCacheRangeRange of integral values for StaticCache indices. The Start is inclusive and the End is exclusive. The range must not be empty
 CCenterOfStar
 CCharacteristicExtractDefaults
 Ccheck_iterable_approx< T, Requires< is_any_spin_weighted_v< T > > >
 Ccheck_variables_approx
 Ccheck_variables_approx< Variables< TagList > >
 CCircularDequeA class implementing the std::deque interface using a circular buffer to avoid allocations when the size does not exceed a previous allocated capacity
 CCleanupRoutineAn object that calls a functor when it goes out of scope
 CComplexDataVectorStores a collection of complex function values
 CComplexDiagonalModalOperatorA class for an element-wise complex multiplier of modal coefficients
 CComplexModalVectorA class for storing complex spectral coefficients on a spectral grid
 CContinuedFractionCompute the continued fraction representation of a number
 CContinuedFractionSummerSum a continued fraction
 CControlComponentThe singleton parallel component responsible for managing a single control system
 CControllerA PND (proportional to Q and N derivatives of Q) controller that computes the control signal:
 Cconvergence_errorException indicating convergence failure
 CCustomComplexStaticSizeVector
 CCustomStaticSizeVector
 CDataVectorStores a collection of function values
 CDenseTriggerBase class for checking whether to run an Event at arbitrary times
 CDgElementArrayThe parallel component responsible for managing the DG elements that compose the computational domain
 CDiagonalModalOperatorA class for an element-wise multiplier of modal coefficients
 CDirectionA particular Side along a particular coordinate Axis
 CDirectionalIdThe ElementId of an Element in a given Direction
 CDirectionalIdMapAn optimized map with DirectionalId keys
 CDirectionHashProvides a perfect hash if the size of the hash table is 2 * Dim. To take advantage of this, use the FixedHashMap class
 CDirectionMapAn optimized map with Direction keys
 CDomainA wrapper around a vector of Blocks that represent the computational domain
 CDomainCreatorBase class for creating Domains from an option string
 CDynamicBufferA dynamically sized vector of DataVectors
 CElementA spectral element with knowledge of its neighbors
 CElementIdAn ElementId uniquely labels an Element
 CElementLogicalCoordHolderHolds element logical coordinates of an arbitrary set of points on a single Element. The arbitrary set of points is assumed to be a subset of a larger set of points spanning multiple Elements, and this class holds offsets that index into that larger set of points
 CElementMapThe CoordinateMap for the Element from the Logical frame to the TargetFrame
 CElementVolumeDataHolds tensor components on a grid, to be written into an H5 file
 CEventBase class for something that can happen during a simulation (such as an observation)
 CEventsAndDenseTriggersClass that checks dense triggers and runs events
 CEventsAndTriggersClass that checks triggers and runs events
 Cevolution_comparatorImplementation of evolution_less, evolution_greater, evolution_less_equal, and evolution_greater_equal
 Cevolution_comparator< void, Comparator >
 CEvolutionMetavars
 CEvolutionMetavars< tmpl::list< InterpolationTargetTags... >, UseParametrizedDeleptonization >
 CExcisionSphereThe excision sphere information of a computational domain. The excision sphere is assumed to be a coordinate sphere in the grid frame
 CExpressionMarks a class as being a TensorExpression
 CFaceCornerIteratorIterates over the 2^(VolumeDim-1) logical corners of the face of a VolumeDim-dimensional cube in the given direction
 CFastFlowFast flow method for finding apparent horizons
 CFixedHashMapA hash table with a compile-time specified maximum size and ability to efficiently handle perfect hashes
 CGeneralizedHarmonicTemplateBase
 Cget_vector_element_typeHelper struct to determine the element type of a VectorImpl or container of VectorImpl
 Cget_vector_element_type< const T, false >
 Cget_vector_element_type< T &, false >
 Cget_vector_element_type< T *, false >
 Cget_vector_element_type< T, false >
 Cget_vector_element_type< T, true >
 CGetContainerElementCallable struct for the subscript operator. Returns t[i]
 CGetContainerSizeCallable struct which retrieves the t.size() for operand t. This will cause a compiler error if no such function exists
 CGhValenciaDivCleanDefaults
 CGhValenciaDivCleanTemplateBase
 CGhValenciaDivCleanTemplateBase< EvolutionMetavarsDerived< UseControlSystems, InterpolationTargetTags... >, UseDgSubcell, UseControlSystems >
 CHypercubeElementAn element of dimension ElementDim on the boundary of a hypercube of dimension HypercubeDim
 CHypercubeElementsIteratorIterator over all ElementDim-dimensional elements on the boundary of a HypercubeDim-dimensional hypercube
 CIdPairA data structure that contains an ID and data associated with that ID
 CImexTimeStepper
 CIndexAn integer multi-index
 CIndexIteratorIndexIterator iterates over a unique set of Index
 CInformerThe Informer manages textual output regarding the status of a simulation
 Cis_any_spin_weightedThis is a std::true_type if the provided type is a SpinWeighted of any type and spin, otherwise is a std::false_type
 Cis_any_spin_weighted< SpinWeighted< T, S > >
 Cis_fractionType trait to check if a type looks like a fraction (specifically, if it has numerator and denominator methods)
 Cis_spin_weighted_ofThis is a std::true_type if the provided type T is a SpinWeighted of InternalType and any spin, otherwise is a std::false_type
 Cis_spin_weighted_of< InternalType, SpinWeighted< InternalType, S > >
 Cis_spin_weighted_of_same_typeThis is a std::true_type if the provided type T1 is a SpinWeighted and T2 is a SpinWeighted, and both have the same internal type, but any combination of spin weights
 Cis_spin_weighted_of_same_type< SpinWeighted< T, Spin1 >, SpinWeighted< T, Spin2 > >
 CKerrHorizon
 CLeviCivitaIteratorIterate over all nonzero index permutations for a Levi-Civita symbol
 CLinkedMessageIdAn identifier for an element in a sequence
 CLinkedMessageIdLessComparator
 CLinkedMessageQueue< Id, tmpl::list< QueueTags... > >A collection of queues of asynchronously received data
 CLtsTimeStepperBase class for TimeSteppers with local time-stepping support, derived from TimeStepper
 Cmake_interface_tag
 Cmake_listMetafunction to turn a parameter pack into a typelist
 CMakeStringMake a string by streaming into object
 CMarkAsAnalyticDataEmpty base class for marking analytic data
 CMarkAsAnalyticSolutionEmpty base class for marking analytic solutions
 CMarkAsVectorImplMarks a class as being a VectorImpl
 CMathFunction
 CMathFunction< 1, Fr >
 CMathWrapperType-erased data for performing math on
 CMatrixA dynamically sized matrix of doubles with column-major storage
 CMeshHolds the number of grid points, basis, and quadrature in each direction of the computational grid
 CModalVectorA class for storing spectral coefficients on a spectral grid
 CNeighborsInformation about the neighbors of a host Element in a particular direction
 CNonCopyable
 CNonFactoryCreatableWrapperSimple struct that changes a class from being factory creatable, to non-factory creatable
 CNonStreamable
 CNoSuchTypeUsed to mark "no type" or "bad state" for metaprogramming
 CNumericDataLoad numeric data from volume data files
 CObservationBox< tmpl::list< ComputeTags... >, DataBoxType >Used for adding compute items to a DataBox without copying or moving any data from the original DataBox
 COrientationMapA mapping of the logical coordinate axes of a host to the logical coordinate axes of a neighbor of the host
 COrientationMapIteratorAn iterator for looping through all possible orientations of the n-dim cube
 COverloaderUsed for overloading lambdas, useful for lambda-SFINAE
 CPairOfFacesEach member in PairOfFaces holds the global corner ids of a block face. PairOfFaces is used in setting up periodic boundary conditions by identifying the two faces with each other
 CPhaseChangePhaseChange objects determine the storage types and logic for moving between phases based on runtime data
 CRandomAmrMetavarsThe metavariables for the RandomAmr executable
 CRationalA rational number
 CScalarTensorTemplateBase
 CScopedFpeStateAn RAII object to temporarily modify the handling of floating point exceptions
 CSegmentIdA SegmentId labels a segment of the interval [1,1] and is used to identify the bounds of an Element in a Block in each dimension
 CSlabA chunk of time. Every element must reach slab boundaries exactly, no matter how it actually takes time steps to get there. The simulation can only be assumed to have global data available at slab boundaries
 CSliceIteratorIterate over a (dim-1)-dimensional slice
 CSpectreAssertException indicating an ASSERT failed
 CSpectreErrorException indicating an ERROR was triggered
 CSpectreFpeException indicating an ERROR was triggered because of an FPE
 CSpinWeightedMake a spin-weighted type T with spin-weight Spin. Mathematical operators are restricted to addition, subtraction, multiplication and division, with spin-weights checked for validity
 CSpinWeighted< T, Spin, false >
 CSpinWeighted< T, Spin, true >
 CStaticCacheA cache of objects intended to be stored in a static variable
 CStaticDequeA class implementing the std::deque interface with static storage
 CStepChooserStepChoosers suggest upper bounds on step sizes. See TimeStepRequest for details on how the results are used
 CStepperErrorEstimateEstimate of the TimeStepper truncation error
 CStepperErrorTolerancesTolerances used for time step error control
 CStripeIteratorIterates over the 1-dimensional stripes with info on how to iterate over the current stripe
 CTempBufferA TempBuffer holds a set of Tensor<DataType>s, where DataType is either a DataVector (or similar type) or a fundamental type, in a way that minimizes allocations
 CTempBuffer< TagList, false >
 CTempBuffer< TagList, true >
 CTensor
 CTensor< X, Symm, IndexList< Indices... > >Represents an object with multiple components
 CTensorComponentAn untyped tensor component with a name for observation
 CTensorExpression< Derived, DataType, Symm, tmpl::list< Indices... >, ArgsList< Args... > >The base class all tensor expression implementations derive from
 CTensorIndexRepresents the geeric indices in a TensorExpression
 CTimeThe time in a simulation. Times can be safely compared for exact equality as long as they do not belong to overlapping unequal slabs
 CTimeDeltaRepresents an interval of time within a single slab
 CTimescaleTunerManages control system timescales
 CTimeSequenceRepresents a sequence of times
 CTimeStepIdA unique identifier for the temporal state of an integrated system
 CTimeStepperAbstract base class for TimeSteppers
 CTimeStepRequestInformation on a requested time-step size returned by StepChoosers
 CTimeStepRequestProcessorCombine TimeStepRequest objects to find a consensus step. See that class for details
 CTriggerBase class for checking whether to run an Event
 CTypeDisplayerGet compiler error with type of template parameter
 CUniformCustomDistributionA uniform distribution function object which redirects appropriately to either the std::uniform_int_distribution or the std::uniform_real_distribution. This also provides a convenience constructor which takes a 2-element array for the bounds for either floating point or int distributions
 CUniformCustomDistribution< bool >
 CVariables< tmpl::list< Tags... > >A Variables holds a contiguous memory block with Tensors pointing into it
 CVariables< tmpl::list<> >
 CVectorImplBase class template for various DataVector and related types
 CVolumeCornerIteratorIterates over the corners of a VolumeDim-dimensional cube