Describing the method to interpolate particle properties to arbitrary positions

Collaboration diagram for Describing the method to interpolate particle properties to arbitrary positions:

Classes
class	aspect::Particle::Interpolator::BilinearLeastSquares< dim >
class	aspect::Particle::Interpolator::CellAverage< dim >
class	aspect::Particle::Interpolator::DistanceWeightedAverage< dim >
class	aspect::Particle::Interpolator::HarmonicAverage< dim >
class	aspect::Particle::Interpolator::Interface< dim >
class	aspect::Particle::Interpolator::NearestNeighbor< dim >
class	aspect::Particle::Interpolator::QuadraticLeastSquares< dim >

Macros
#define	ASPECT_REGISTER_PARTICLE_INTERPOLATOR(classname, name, description)

Functions
template<int dim>
void	aspect::Particle::Interpolator::register_particle_interpolator (const std::string &name, const std::string &description, void(*declare_parameters_function)(ParameterHandler &), std::unique_ptr< Interface< dim >>(*factory_function)())
template<int dim>
std::unique_ptr< Interface< dim > >	aspect::Particle::Interpolator::create_particle_interpolator (ParameterHandler &prm)
template<int dim>
void	aspect::Particle::Interpolator::declare_parameters (ParameterHandler &prm)

Detailed Description

A module for the definition of functions and classes that have to do with interpolating particle properties to arbitrary positions.

Macro Definition Documentation

ASPECT_REGISTER_PARTICLE_INTERPOLATOR

#define ASPECT_REGISTER_PARTICLE_INTERPOLATOR	(		classname,
			name,
			description
	)

Value:

template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_PARTICLE_INTERPOLATOR_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::Particle::Interpolator::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::Particle::Interpolator::register_particle_interpolator<2>, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::Particle::Interpolator::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::Particle::Interpolator::register_particle_interpolator<3>, \
                                name, description); \
  }

Given a class name, a name, and a description for the parameter file for a particle interpolator, register it with the functions that can declare their parameters and create these objects.

Definition at line 162 of file interface.h.

Function Documentation

register_particle_interpolator()

template<int dim>

void aspect::Particle::Interpolator::register_particle_interpolator	(	const std::string &	name,
		const std::string &	description,
		void(*)(ParameterHandler &)	declare_parameters_function,
		std::unique_ptr< Interface< dim >>(*)()	factory_function
	)

Register a particle interpolator so that it can be selected from the parameter file.

Parameters

name	A string that identifies the particle interpolator
description	A text description of what this interpolator does and that will be listed in the documentation of the parameter file.
declare_parameters_function	A pointer to a function that can be used to declare the parameters that this particle interpolator wants to read from input files.
factory_function	A pointer to a function that can create an object of this particle interpolator.

create_particle_interpolator()

template<int dim>

std::unique_ptr<Interface<dim> > aspect::Particle::Interpolator::create_particle_interpolator

(

ParameterHandler &

prm

)

A function that given the name of a model returns a pointer to an object that describes it. Ownership of the pointer is transferred to the caller.

The model object returned is not yet initialized and has not read its runtime parameters yet.

declare_parameters()

template<int dim>

void aspect::Particle::Interpolator::declare_parameters

(

ParameterHandler &

prm

)

Declare the runtime parameters of the registered particle interpolators.