Uses of Class
pulse.util.Group

Packages that use Group

Package	Description
pulse	Contains some of the most frequently used classes, which did not seem to fit in any other packages.
pulse.baseline	Contains classes for describing and evaluating the baseline signal of a HeatingCurve or its subclasses.
pulse.input	Introduces internal data structures that (a) are created as a result of parsing specific types of input files, such as: experimental heating curves, metadata, and property curves (e.g.
pulse.io.export	Package contains the PULsE export API, which currently consists of different exporter classes, an export manager, an XML converter and a MassExporter class.
pulse.math	Provides general math functionality that is used when finding the direction (a Vector) of the minimum, including operations with vector and matrices.
pulse.math.filters
pulse.problem.laser	This package deals with discrete laser pulse representation and their various temporal shapes.
pulse.problem.schemes	This package deals with abstractions associated with finite differences in PULsE, including the definition of Grids, which determine the partitioning rules for space and time variables.
pulse.problem.schemes.rte	Contains generic classes that act as a bridge between the specific implementation of radiative heat transfer and the heat problem solvers.
pulse.problem.schemes.rte.dom	Contains the implementation of the discrete ordinates method (DOM) for the solution of a anisotropic nonlinear radiative transfer equation.
pulse.problem.schemes.rte.exact	Contains classes for solving the radiative transfer equation in an absorbing-emitting medium (no scattering) using a semi-analytical approach.
pulse.problem.schemes.solvers	Contains various finite-difference solvers for the different problem statements available.
pulse.problem.statements	Introduces various problem statements for the heat conduction problem in the laser flash experiment.
pulse.problem.statements.model
pulse.search
pulse.search.direction	Provides a list of PathSolvers and associated classes, which are used to determine the direction of the minimum of a specific SearchTask using an iterative approach.
pulse.search.direction.pso
pulse.search.linear	Provides classes that are able to search for the minimum of a scalar function of a vector variable that is unimodal on a specific Segment.
pulse.search.statistics	PULsE Statistical Kit.
pulse.tasks	Introduces the SearchTask, which is the main actor in PULsE, and the TaskManager, a high-level class which among other functions manages loading and executing SearchTasks.
pulse.tasks.logs	Lists classes for logging, storing runtime information including statuses.
pulse.tasks.processing	Lists classes for storing runtime information, storing and ordering of final execution results, storing intermediate results of execution to check convergence.
pulse.util	Contains abstract data and hierarchical structures that implement much of the Java Reflection API.

Uses of Group in pulse

Subclasses of Group in pulse

Modifier and Type	Class	Description
class	AbstractData	A named collection of time and temperature values, with user-adjustable number of entries.
class	HeatingCurve	The HeatingCurve represents a time-temperature profile (a AbstractData instance) generated using a calculation algorithm implemented by a Problem's Solver.

Uses of Group in pulse.baseline

Subclasses of Group in pulse.baseline

Modifier and Type	Class	Description
class	AdjustableBaseline	A baseline that can shift in the vertical direction.
class	Baseline	An abstract class for baseline calculations.
class	FlatBaseline	A flat baseline.
class	LinearBaseline	A linear Baseline which specifies the intercept and slope parameters.
class	SinusoidalBaseline	A multiple-harmonic baseline.

Methods in pulse.baseline that return types with arguments of type Group

Modifier and Type	Method	Description
List<Group>	SinusoidalBaseline.subgroups()

Uses of Group in pulse.input

Subclasses of Group in pulse.input

Modifier and Type	Class	Description
class	ExperimentalData	An ExperimentalData object is essentially a AbstractData with adjustable range and linked Metadata.
class	Metadata	Metadata is the information relating to a specific experiment, which can be used by a SearchTask to process an instance of ExperimentalData.
class	Range	The actual physical range defined as a Segment with minimum and maximum values.

Uses of Group in pulse.io.export

Methods in pulse.io.export with parameters of type Group

Modifier and Type	Method	Description
static void	ExportManager.exportGroup(Group group, File directory, Extension extension)	Fully exports group and all its contents to the root directory requesting the files to be saved with the extension.

Uses of Group in pulse.math

Subclasses of Group in pulse.math

Modifier and Type	Class	Description
class	AbstractIntegrator	An AbstractIntegrator serves to calculate the definite integral of a function.
class	FixedIntervalIntegrator	A fixed-interval integrator implements a numerical scheme in which the domain within the integration bounds is divided into equal intervals of a sufficiently small (and fixed) length.
class	Harmonic	Harmonic class.
class	MidpointIntegrator	Implements the midpoint integration scheme for the evaluation of definite integrals.
class	SimpsonIntegrator	Implements the Simpson's integration rule for the evaluation of definite integrals.

Uses of Group in pulse.math.filters

Subclasses of Group in pulse.math.filters

Modifier and Type	Class	Description
class	OptimisablePolyline
class	PolylineOptimiser

Uses of Group in pulse.problem.laser

Subclasses of Group in pulse.problem.laser

Modifier and Type	Class	Description
class	ExponentiallyModifiedGaussian	Represents the exponentially modified Gaussian function, which is given by three independent parameters (μ, σ and λ).
class	NumericPulse	A numeric pulse is given by a set of discrete NumericPulseData measured independently using a pulse diode.
class	NumericPulseData	An instance of the AbstractData class, which also declares an externalID.
class	PulseTemporalShape	An abstract time-dependent pulse shape.
class	RectangularPulse	The simplest pulse shape defined as $0.5*(1\; +\; sgn($tpulse - t)), where $sgn(...)$ is the signum function, pulse is the pulse width.
class	TrapezoidalPulse	A trapezoidal pulse shape, which combines a rise segment, a constant-power segment, and a fall segment.

Uses of Group in pulse.problem.schemes

Subclasses of Group in pulse.problem.schemes

Modifier and Type	Class	Description
class	ADIScheme	An ADIScheme uses a Grid2D to provide numerical capabilities needed to solve a Problem.
class	CoupledImplicitScheme
class	DifferenceScheme	A DifferenceScheme is an abstract class that declares general methods for converting a Problem to a set of algebraic operations on a Grid.
class	ExplicitScheme	This class provides the necessary framework to enable a simple explicit finite-difference scheme (also called the forward-time centred space scheme) for solving the one-dimensional heat conduction problem.
class	Grid	A Grid is used to partition the space and time domain of a Problem to allow a numeric solution with a DifferenceScheme.
class	Grid2D	A Grid2D is used to partition the space and time domain of a Problem2D to allow a numeric solution with a DifferenceScheme.
class	ImplicitScheme	An abstract implicit finite-difference scheme for solving one-dimensional heat conduction problems.
class	MixedScheme	An abstraction describing a weighted semi-implicit finite-difference scheme for solving the one-dimensional heat conduction problem.
class	OneDimensionalScheme
class	RadiativeTransferCoupling

Uses of Group in pulse.problem.schemes.rte

Subclasses of Group in pulse.problem.schemes.rte

Modifier and Type	Class	Description
class	RadiativeTransferSolver	Manages processes to solve the radiative transfer equation and generate the input needed by the heat problem, i.e.

Uses of Group in pulse.problem.schemes.rte.dom

Subclasses of Group in pulse.problem.schemes.rte.dom

Modifier and Type	Class	Description
class	AdaptiveIntegrator	An ODE integrator with an adaptive step size.
class	DiscreteOrdinatesMethod	A class that manages the solution of the radiative transfer equation using the discrete ordinates method.
class	Discretisation	A class specifying the discretisation (both spatial and angular) scheme used to solve the radiative transfer equation with the discrete ordinates method.
class	ExplicitRungeKutta	Explicit Runge-Kutta integrator with Hermite interpolation for the solution of one-dimensional radiative transfer problems.
class	FixedIterations
class	IterativeSolver	Used to iteratively solve the radiative transfer problem.
class	ODEIntegrator
class	StretchedGrid
class	SuccessiveOverrelaxation
class	TRBDF2	TRBDF2 (Trapezoidal Backward Differencing Second Order) Scheme for the solution of one-dimensional radiative transfer problems.

Uses of Group in pulse.problem.schemes.rte.exact

Subclasses of Group in pulse.problem.schemes.rte.exact

Modifier and Type	Class	Description
class	ChandrasekharsQuadrature	This quadrature methods of evaluating the composition product of the exponential integral and blackbody spectral power spectrum has been given by Chandrasekhar and is based on constructing a moment matrix.
class	CompositionProduct	A class for evaluating the definite integral $\int$ab f(x) En (α + β x) dx}.
class	NewtonCotesQuadrature	A class for evaluating the composition product using a simple Newton-Cotes quadrature with a cutoff.
class	NonscatteringAnalyticalDerivatives	A solver of the radiative transfer equation for an absorbing-emitting medium where the fluxes and their derivatives are calculated using analytical formulae with the selected numerical quadrature.
class	NonscatteringDiscreteDerivatives	A solver of the radiative transfer equation for an absorbing-emitting medium where the fluxes are calculated using analytical formulae while their derivatives are calculated using the central-difference approximation.
class	NonscatteringRadiativeTransfer

Uses of Group in pulse.problem.schemes.solvers

Subclasses of Group in pulse.problem.schemes.solvers

Modifier and Type	Class	Description
class	ADILinearisedSolver	An alternating direction implicit (ADI) solver for a classical two-dimensional linearised problem.
class	ExplicitCoupledSolver
class	ExplicitCoupledSolverNL
class	ExplicitLinearisedSolver	Performs a fully-dimensionless calculation for the LinearisedProblem.
class	ExplicitNonlinearSolver
class	ExplicitTranslucentSolver
class	ImplicitCoupledSolver
class	ImplicitCoupledSolverNL
class	ImplicitDiathermicSolver
class	ImplicitLinearisedSolver<T extends ClassicalProblem>	Performs a fully-dimensionless calculation for the LinearisedProblem.
class	ImplicitNonlinearSolver
class	ImplicitTranslucentSolver
class	ImplicitTwoTemperatureSolver
class	MixedCoupledSolver
class	MixedCoupledSolverNL
class	MixedLinearisedSolver	Performs a fully-dimensionless calculation for the LinearisedProblem.

Uses of Group in pulse.problem.statements

Subclasses of Group in pulse.problem.statements

Modifier and Type	Class	Description
class	ClassicalProblem	The simplest problem statement supported in PULsE, which is formulated in the dimensionless form and with linearised boundary conditions.
class	ClassicalProblem2D	The complete problem statement for a fully two-dimensional problem, which includes side heat losses, a variable field of view and variable pulse-to-diameter ratio.
class	DiathermicMedium	The diathermic model is based on the following propositions: - A cylindrically shaped sample is completely transparent to thermal radiation; - The front~(laser-facing) and rear (detector-facing) sides of the sample are coated by a thin grey absorber; - The coatings are in perfect thermal contact with the bulk material; - The side surface is free from any coating.
class	NonlinearProblem
class	ParticipatingMedium
class	PenetrationProblem
class	Problem	A Problem is an abstract class defining the general rules for handling heat conduction problems, and also providing access to the basic properties used in the calculation with one of the DifferenceSchemes.
class	Pulse	A Pulse stores the parameters of the laser pulse, but does not provide the calculation facilities.
class	Pulse2D
class	TwoTemperatureModel

Uses of Group in pulse.problem.statements.model

Subclasses of Group in pulse.problem.statements.model

Modifier and Type	Class	Description
class	AbsorptionModel
class	BeerLambertAbsorption
class	DiathermicProperties
class	ExtendedThermalProperties
class	Insulator
class	ThermalProperties
class	ThermoOpticalProperties
class	TwoTemperatureProperties

Uses of Group in pulse.search

Subclasses of Group in pulse.search

Modifier and Type	Class	Description
class	GeneralTask<I extends DiscreteInput,R extends Response>
class	SimpleOptimisationTask<T extends PropertyHolder & Optimisable>	Generic optimisation class.

Uses of Group in pulse.search.direction

Subclasses of Group in pulse.search.direction

Modifier and Type	Class	Description
class	BFGSOptimiser	The 'advanced' PathSolver implementing the variable-metric (quasi-Newton) search method.
class	CompositePathOptimiser
class	GradientBasedOptimiser
class	LMOptimiser	Given an objective function equal to the sum of squared residuals, iteratively approaches the minimum of this function by applying the Levenberg-Marquardt formulas.
class	PathOptimiser	An abstract class that defines the mathematical basis of solving the reverse heat conduction problem.
class	SR1Optimiser
class	SteepestDescentOptimiser	The simplest possible PathSolver, which assumes that the minimum direction coincides with the inverted gradient.

Uses of Group in pulse.search.direction.pso

Subclasses of Group in pulse.search.direction.pso

Modifier and Type	Class	Description
class	ParticleSwarmOptimiser

Uses of Group in pulse.search.linear

Subclasses of Group in pulse.search.linear

Modifier and Type	Class	Description
class	GoldenSectionOptimiser	The golden-section search is a simple dichotomy search for finding the minimum of strictly unimodal functions by successively narrowing the domain of the search using the golden ratio partitioning.
class	LinearOptimiser	The most basic LinearSolver class, which defines the notion of the linear resolution, defines the method signature for estimating the step of the linear search (i.e., the position of the minimum), and provides a simple algorithm to initialise the calculation domain.
class	WolfeOptimiser	This is the implementation of the strong Wolfe conditions for performing inexact linear search.

Uses of Group in pulse.search.statistics

Subclasses of Group in pulse.search.statistics

Modifier and Type	Class	Description
class	AbsoluteDeviations	A statistical optimality criterion relying on absolute deviations or the L1 norm condition.
class	AICStatistic	AIC algorithm: Banks, H.
class	AndersonDarlingTest	The Anderson-Darling normality test.
class	BICStatistic	Bayesian Information Criterion (BIC) algorithm formulated for the Gaussian distribution of residuals.
class	CorrelationTest
class	EmptyCorrelationTest
class	EmptyTest
class	KSTest	The Kolmogorov-Smirnov normality test as implemented in ApacheCommonsMath.
class	ModelSelectionCriterion	An abstract superclass for the BIC and AIC statistics.
class	NormalityTest	A normality test is invoked after a task finishes, to validate its result.
class	OptimiserStatistic	An Optimiser statistic is simply the objective function that is calculated by the Optimiser.
class	PearsonCorrelation	Wrapper CorrelationTest class for ApacheCommonsMath Pearson Correlation.
class	RangePenalisedLeastSquares	This is an experimental feature.
class	RegularisedLeastSquares	This is an experimental feature.
class	ResidualStatistic	An abstract statistic (= a numeric value resulting from a statistical procedure) that operates with model residuals.
class	RSquaredTest	The coefficient of determination represents the goodness of fit that a HeatingCurve provides for the ExperimentalData
class	SpearmansCorrelationTest	Wrapper CorrelationTest class for ApacheCommonsMath Spearmans Correlation.
class	Statistic	A statistic is an abstract class that hosts the evaluate method to validate the results of a SearchTask.
class	SumOfSquares	The standard optimality criterion of the L2 norm condition, or simply ordinary least squares.

Uses of Group in pulse.tasks

Subclasses of Group in pulse.tasks

Modifier and Type	Class	Description
class	Calculation
class	SearchTask	A SearchTask is the most important class in PULsE.

Methods in pulse.tasks that return types with arguments of type Group

Modifier and Type	Method	Description
Set<Group>	TaskManager.allGrouppedContents()

Uses of Group in pulse.tasks.logs

Subclasses of Group in pulse.tasks.logs

Modifier and Type	Class	Description
class	Log	A Log is used to track changes for a specific SearchTask, such as changes of status and/or data collection events.

Uses of Group in pulse.tasks.processing

Subclasses of Group in pulse.tasks.processing

Modifier and Type	Class	Description
class	Buffer	A Buffer is used to estimate the convergence of the reverse problem solution, by comparing the variance of the properties to a pre-specified error tolerance.

Uses of Group in pulse.util

Subclasses of Group in pulse.util

Modifier and Type	Class	Description
class	Accessible	An Accessible provides Reflection-based read- and write-access to the underlying (usually declared as its own fields - but not necessarily) instances of Property and a recursive access to other Accessible, which may have a family relationship with this Accessible via the UpwardsNavigable implementation.
class	PropertyHolder	An Accessible that has a list of parameters it accepts as its own and a list of PropertyHolderListener that track changes with all properties of the Accessible.

Methods in pulse.util that return Group

Modifier and Type	Method	Description
Group	Group.access(String simpleName)	Searches for a specific Accessible with a simpleName.

Methods in pulse.util that return types with arguments of type Group

Modifier and Type	Method	Description
List<Group>	Group.children()	Selects only those Accessibles, the parent of which is this.
static Set<Group>	Group.contents(Group root)	Recursively analyses all Group objects that are identified as subgroups to root (explicitly checks that subgroups exclude parents of root) and chooses those for which an Exporter exists.
List<Group>	Group.subgroups()	Tries to access getter methods to retrieve all Accessible instances belonging to this object.

Methods in pulse.util with parameters of type Group

Modifier and Type	Method	Description
static Set<Group>	Group.contents(Group root)	Recursively analyses all Group objects that are identified as subgroups to root (explicitly checks that subgroups exclude parents of root) and chooses those for which an Exporter exists.