ASPECT
Public Member Functions | Static Public Member Functions | List of all members
aspect::Plugins::InterfaceBase Class Reference
Inheritance diagram for aspect::Plugins::InterfaceBase:
Inheritance graph
[legend]

Public Member Functions

virtual ~InterfaceBase ()=default
 
virtual void initialize ()
 
virtual void update ()
 
virtual void parse_parameters (ParameterHandler &prm)
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 

Detailed Description

A base class for all plugin systems. The class ensures that a common set of functions is declared as virtual (namely, the destructor, initialize(), update(), and parse_parameters()) and implemented with empty bodies so that derived interface classes do not have to declare these functions themselves. Furthermore, the class provides an empty, static function declare_parameters() that derived classes can re-implement to declare their parameters.

Definition at line 130 of file plugins.h.

Constructor & Destructor Documentation

§ ~InterfaceBase()

virtual aspect::Plugins::InterfaceBase::~InterfaceBase ( )
virtualdefault

Destructor. Made virtual to enforce that derived classes also have virtual destructors.

Member Function Documentation

§ initialize()

virtual void aspect::Plugins::InterfaceBase::initialize ( )
virtual

Initialization function. This function is called once at the beginning of the program after parse_parameters() is run and after the SimulatorAccess (if applicable) is initialized.

The default implementation of this function does nothing, but plugins that derive from this class (via the Interface classes of their respective plugin systems) may overload it if they want something to happen upon startup of the Simulator object to which the plugin contributes.

Reimplemented in aspect::Particle::Property::Manager< dim >, aspect::GeometryModel::Chunk< dim >, aspect::Particle::Property::ElasticTensorDecomposition< dim >, aspect::GeometryModel::SphericalShell< dim >, aspect::BoundaryVelocity::GPlates< dim >, aspect::GeometryModel::EllipsoidalChunk< dim >, aspect::Particle::Property::CrystalPreferredOrientation< dim >, aspect::MaterialModel::Steinberger< dim >, aspect::InitialTemperature::LithosphereMask< dim >, aspect::InitialTemperature::S40RTSPerturbation< dim >, aspect::MaterialModel::GrainSize< dim >, aspect::MaterialModel::ReactiveFluidTransport< dim >, aspect::GravityModel::RadialEarthLike< dim >, aspect::Particle::Property::CpoBinghamAverage< dim >, aspect::InitialTemperature::Adiabatic< dim >, aspect::GeometryModel::TwoMergedChunks< dim >, aspect::MaterialModel::MeltBoukare< dim >, aspect::MaterialModel::MeltSimple< dim >, aspect::Particle::Generator::Interface< dim >, aspect::BoundaryComposition::TwoMergedBoxes< dim >, aspect::MaterialModel::PerpleXLookup< dim >, aspect::Postprocess::Geoid< dim >, aspect::MaterialModel::Compositing< dim >, aspect::Postprocess::GravityPointValues< dim >, aspect::InitialTemperature::SAVANIPerturbation< dim >, aspect::Postprocess::CrystalPreferredOrientation< dim >, aspect::AdiabaticConditions::ComputeProfile< dim >, aspect::Particle::Property::CpoElasticTensor< dim >, aspect::AdiabaticConditions::ComputeEntropyProfile< dim >, aspect::MaterialModel::AsciiReferenceProfile< dim >, aspect::Postprocess::VisualizationPostprocessors::Geoid< dim >, aspect::MaterialModel::EntropyModel< dim >, aspect::InitialComposition::SlabModel< dim >, aspect::InitialTemperature::AdiabaticBoundary< dim >, aspect::InitialTemperature::PatchOnS40RTS< dim >, aspect::AdiabaticConditions::AsciiData< dim >, aspect::BoundaryComposition::AsciiData< dim >, aspect::BoundaryComposition::Box< dim >, aspect::BoundaryVelocity::AsciiData< dim >, aspect::InitialComposition::AsciiData< dim >, aspect::InitialComposition::AsciiDataLayered< dim >, aspect::Postprocess::GlobalStatistics< dim >, aspect::Postprocess::VisualizationPostprocessors::NamedAdditionalOutputs< dim >, aspect::BoundaryTemperature::AsciiData< dim >, aspect::InitialTemperature::AsciiData< dim >, aspect::InitialTemperature::AsciiDataLayered< dim >, aspect::InitialTemperature::AsciiProfile< dim >, aspect::MeshDeformation::AsciiData< dim >, aspect::PrescribedStokesSolution::AsciiData< dim >, aspect::InitialTopographyModel::AsciiData< dim >, aspect::BoundaryComposition::InitialComposition< dim >, aspect::BoundaryTraction::AsciiData< dim >, aspect::GravityModel::AsciiData< dim >, aspect::Particle::Property::PTPath< dim >, aspect::InitialComposition::Porosity< dim >, aspect::Particle::Property::GrainSize< dim >, aspect::AdiabaticConditions::Function< dim >, aspect::BoundaryTemperature::InitialTemperature< dim >, aspect::InitialTemperature::PrescribedTemperature< dim >, aspect::MaterialModel::DepthDependent< dim >, aspect::Postprocess::StokesResidual< dim >, aspect::Particle::Property::ViscoPlasticStrainInvariant< dim >, aspect::BoundaryComposition::SphericalConstant< dim >, aspect::BoundaryTraction::InitialLithostaticPressure< dim >, aspect::InitialComposition::EntropyTableLookUp< dim >, aspect::InitialTemperature::ContinentalGeotherm< dim >, aspect::MaterialModel::ReplaceLithosphereViscosity< dim >, aspect::MeshDeformation::Diffusion< dim >, aspect::Particle::Integrator::RK2< dim >, aspect::InitialTemperature::RandomGaussianPerturbation< dim >, aspect::MaterialModel::PrescribedViscosity< dim >, aspect::MeshDeformation::FreeSurface< dim >, aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >, aspect::Postprocess::SeaLevel< dim >, aspect::Particle::Property::ElasticStress< dim >, aspect::Postprocess::BoundaryStrainRateResidualStatistics< dim >, aspect::Particle::Integrator::RK4< dim >, aspect::BoundaryTemperature::SphericalConstant< dim >, aspect::MaterialModel::Nondimensional< dim >, aspect::GeometryModel::Box< dim >, aspect::Particle::Interpolator::DistanceWeightedAverage< dim >, and aspect::Postprocess::ODEStatistics< dim >.

§ update()

virtual void aspect::Plugins::InterfaceBase::update ( )
virtual

A function that is called at the beginning of each time step.

The default implementation of this function does nothing, but plugins that derive from this class (via the Interface classes of their respective plugin systems) may overload it if they want something to happen upon startup of the Simulator object to which the plugin contributes.

Reimplemented in aspect::Postprocess::Visualization< dim >, aspect::Plugins::ManagerBase< InterfaceType >, aspect::Plugins::ManagerBase< Interface< dim > >, aspect::BoundaryVelocity::GPlates< dim >, aspect::BoundaryTemperature::DynamicCore< dim >, aspect::TimeStepping::Manager< dim >, aspect::MaterialModel::Steinberger< dim >, aspect::MeshRefinement::Isosurfaces< dim >, aspect::MaterialModel::ReactiveFluidTransport< dim >, aspect::BoundaryTraction::AsciiData< dim >, aspect::BoundaryVelocity::Function< dim >, aspect::BoundaryComposition::AsciiData< dim >, aspect::BoundaryTraction::Function< dim >, aspect::BoundaryVelocity::AsciiData< dim >, aspect::AdiabaticConditions::ComputeProfile< dim >, aspect::BoundaryTemperature::AsciiData< dim >, aspect::BoundaryTemperature::Function< dim >, aspect::HeatingModel::Function< dim >, aspect::PrescribedStokesSolution::Function< dim >, aspect::BoundaryHeatFlux::Function< dim >, aspect::BoundaryComposition::Function< dim >, aspect::MaterialModel::DepthDependent< dim >, aspect::GravityModel::Function< dim >, aspect::MeshDeformation::Diffusion< dim >, aspect::MaterialModel::PrescribedViscosity< dim >, aspect::Postprocess::VisualizationPostprocessors::HeatFluxMap< dim >, aspect::Postprocess::VisualizationPostprocessors::TemperatureAnomaly< dim >, aspect::MeshRefinement::MinimumRefinementFunction< dim >, aspect::MeshRefinement::MaximumRefinementFunction< dim >, and aspect::MeshDeformation::BoundaryFunction< dim >.

§ declare_parameters()

static void aspect::Plugins::InterfaceBase::declare_parameters ( ParameterHandler &  prm)
static

Declare the parameters the plugin takes through input files. The default implementation of this function does not describe any parameters. Consequently, derived classes do not have to overload this function if they do not take any runtime parameters. On the other hand, most plugins do have run-time parameters, and they may then overload this function.

§ parse_parameters()

virtual void aspect::Plugins::InterfaceBase::parse_parameters ( ParameterHandler &  prm)
virtual

Read the parameters this class declares from the parameter file. The default implementation of this function does not read any parameters. Consequently, derived classes do not have to overload this function if they do not take any runtime parameters. On the other hand, most plugins do have run-time parameters, and they may then overload this function.

Reimplemented in aspect::Particle::Property::Manager< dim >, aspect::Particle::Property::IntegratorProperties< dim >, aspect::GeometryModel::Chunk< dim >, aspect::Postprocess::Visualization< dim >, aspect::GeometryModel::SphericalShell< dim >, aspect::Particle::Property::CrystalPreferredOrientation< dim >, aspect::GeometryModel::EllipsoidalChunk< dim >, aspect::GeometryModel::TwoMergedChunks< dim >, aspect::Postprocess::Manager< dim >, aspect::GeometryModel::Box< dim >, aspect::BoundaryVelocity::GPlates< dim >, aspect::MaterialModel::ViscoPlastic< dim >, aspect::HeatingModel::Manager< dim >, aspect::MaterialModel::Steinberger< dim >, aspect::GeometryModel::TwoMergedBoxes< dim >, aspect::TimeStepping::Manager< dim >, aspect::MaterialModel::Viscoelastic< dim >, aspect::Postprocess::Particles< dim >, aspect::Particle::Property::CpoBinghamAverage< dim >, aspect::Particle::Property::CpoElasticTensor< dim >, aspect::TerminationCriteria::Manager< dim >, aspect::MeshRefinement::Manager< dim >, aspect::InitialTemperature::LithosphereMask< dim >, aspect::BoundaryTemperature::DynamicCore< dim >, aspect::GeometryModel::Sphere< dim >, aspect::MeshRefinement::Isosurfaces< dim >, aspect::MaterialModel::GrainSize< dim >, aspect::MaterialModel::DruckerPrager< dim >, aspect::Postprocess::VisualizationPostprocessors::SeismicVpAnomaly< dim >, aspect::InitialTemperature::S40RTSPerturbation< dim >, aspect::GravityModel::RadialLinear< dim >, aspect::MaterialModel::MeltBoukare< dim >, aspect::BoundaryTemperature::Manager< dim >, aspect::InitialTemperature::SphericalGaussianPerturbation< dim >, aspect::MaterialModel::ReactiveFluidTransport< dim >, aspect::MaterialModel::Averaging< dim >, aspect::Particle::Integrator::RK2< dim >, aspect::AdiabaticConditions::ComputeProfile< dim >, aspect::MaterialModel::MeltSimple< dim >, aspect::BoundaryTemperature::AsciiData< dim >, aspect::InitialTemperature::InclusionShapeBox< dim >, aspect::AdiabaticConditions::AsciiData< dim >, aspect::MaterialModel::MulticomponentCompressible< dim >, aspect::Particle::Property::MeltParticle< dim >, aspect::BoundaryTemperature::Function< dim >, aspect::MaterialModel::DiffusionDislocation< dim >, aspect::MaterialModel::Multicomponent< dim >, aspect::BoundaryComposition::Manager< dim >, aspect::InitialTemperature::Adiabatic< dim >, aspect::InitialTemperature::PatchOnS40RTS< dim >, aspect::MaterialModel::MeltGlobal< dim >, aspect::AdiabaticConditions::ComputeEntropyProfile< dim >, aspect::MaterialModel::EntropyModel< dim >, aspect::BoundaryTraction::AsciiData< dim >, aspect::MaterialModel::LatentHeatMelt< dim >, aspect::MaterialModel::SimpleCompressible< dim >, aspect::MaterialModel::Compositing< dim >, aspect::AdiabaticConditions::Function< dim >, aspect::BoundaryTemperature::InitialTemperature< dim >, aspect::BoundaryVelocity::AsciiData< dim >, aspect::MaterialModel::PerpleXLookup< dim >, aspect::InitialTopographyModel::AsciiData< dim >, aspect::BoundaryComposition::AsciiData< dim >, aspect::BoundaryComposition::InitialComposition< dim >, aspect::MaterialModel::AsciiReferenceProfile< dim >, aspect::Particle::Generator::ProbabilityDensityFunction< dim >, aspect::InitialTemperature::SAVANIPerturbation< dim >, aspect::BoundaryVelocity::Function< dim >, aspect::HeatingModel::AdiabaticHeating< dim >, aspect::InitialComposition::Manager< dim >, aspect::MaterialModel::LatentHeat< dim >, aspect::MaterialModel::ModifiedTait< dim >, aspect::Postprocess::CrystalPreferredOrientation< dim >, aspect::BoundaryTemperature::SphericalConstant< dim >, aspect::InitialTemperature::Manager< dim >, aspect::BoundaryTraction::Function< dim >, aspect::MaterialModel::CompositionReaction< dim >, aspect::Postprocess::SeaLevel< dim >, aspect::Postprocess::VisualizationPostprocessors::VolumeOfFluidValues< dim >, aspect::MeshDeformation::AsciiData< dim >, aspect::MeshDeformation::Diffusion< dim >, aspect::MeshDeformation::FreeSurface< dim >, aspect::Postprocess::GravityPointValues< dim >, aspect::BoundaryTemperature::Constant< dim >, aspect::MaterialModel::Nondimensional< dim >, aspect::MaterialModel::DepthDependent< dim >, aspect::MaterialModel::Simple< dim >, aspect::BoundaryTemperature::TwoMergedBoxes< dim >, aspect::HeatingModel::AdiabaticHeatingMelt< dim >, aspect::Particle::Property::Function< dim >, aspect::Postprocess::VisualizationPostprocessors::MaterialProperties< dim >, aspect::BoundaryTemperature::Box< dim >, aspect::GravityModel::AsciiData< dim >, aspect::GravityModel::Function< dim >, aspect::BoundaryHeatFlux::Function< dim >, aspect::InitialComposition::AsciiDataLayered< dim >, aspect::Particle::Generator::UniformRadial< dim >, aspect::HeatingModel::Function< dim >, aspect::InitialComposition::SlabModel< dim >, aspect::InitialTemperature::AsciiData< dim >, aspect::InitialTemperature::AsciiDataLayered< dim >, aspect::PrescribedStokesSolution::AsciiData< dim >, aspect::BoundaryComposition::Function< dim >, aspect::BoundaryTraction::InitialLithostaticPressure< dim >, aspect::InitialComposition::AsciiData< dim >, aspect::MaterialModel::PrescribedViscosity< dim >, aspect::Postprocess::DynamicTopography< dim >, aspect::InitialTemperature::AdiabaticBoundary< dim >, aspect::InitialTemperature::AsciiProfile< dim >, aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >, aspect::PrescribedStokesSolution::Function< dim >, aspect::Postprocess::VisualizationPostprocessors::HeatFluxMap< dim >, aspect::BoundaryComposition::SphericalConstant< dim >, aspect::HeatingModel::ShearHeating< dim >, aspect::Postprocess::BoundaryStrainRateResidualStatistics< dim >, aspect::Postprocess::GlobalStatistics< dim >, aspect::MeshDeformation::BoundaryFunction< dim >, aspect::Particle::Interpolator::QuadraticLeastSquares< dim >, aspect::InitialTemperature::Function< dim >, aspect::MeshRefinement::MinimumRefinementFunction< dim >, aspect::Postprocess::VisualizationPostprocessors::MeltMaterialProperties< dim >, aspect::MeshRefinement::MaximumRefinementFunction< dim >, aspect::Particle::Generator::ReferenceCell< dim >, aspect::Particle::Generator::UniformBox< dim >, aspect::HeatingModel::LatentHeatMelt< dim >, aspect::InitialComposition::EntropyTableLookUp< dim >, aspect::InitialTemperature::ContinentalGeotherm< dim >, aspect::MaterialModel::ReplaceLithosphereViscosity< dim >, aspect::BoundaryComposition::Box< dim >, aspect::HeatingModel::RadioactiveDecay< dim >, aspect::InitialComposition::Function< dim >, aspect::MaterialModel::Simpler< dim >, aspect::MeshRefinement::Boundary< dim >, aspect::BoundaryFluidPressure::Density< dim >, aspect::InitialTemperature::RandomGaussianPerturbation< dim >, aspect::Postprocess::PointValues< dim >, aspect::TerminationCriteria::EndTime< dim >, aspect::InitialTopographyModel::Function< dim >, aspect::Particle::Generator::AsciiFile< dim >, aspect::Particle::Generator::RandomUniform< dim >, aspect::Particle::Interpolator::BilinearLeastSquares< dim >, aspect::Postprocess::VisualizationPostprocessors::MeltFraction< dim >, aspect::Postprocess::VisualizationPostprocessors::PrincipalStress< dim >, aspect::Postprocess::DepthAverage< dim >, aspect::Postprocess::VisualizationPostprocessors::CompositionalVector< dim >, aspect::Postprocess::VisualizationPostprocessors::SeismicVsAnomaly< dim >, aspect::Postprocess::VisualizationPostprocessors::TemperatureAnomaly< dim >, aspect::MeshRefinement::CompactionLength< dim >, aspect::Particle::Interpolator::NearestNeighbor< dim >, aspect::Postprocess::VisualizationPostprocessors::ArtificialViscosityComposition< dim >, aspect::HeatingModel::ConstantHeating< dim >, aspect::MeshRefinement::Composition< dim >, aspect::MeshRefinement::CompositionApproximateGradient< dim >, aspect::MeshRefinement::CompositionGradient< dim >, aspect::Postprocess::Geoid< dim >, aspect::Particle::Interpolator::CellAverage< dim >, aspect::Particle::Interpolator::HarmonicAverage< dim >, aspect::BoundaryComposition::TwoMergedBoxes< dim >, aspect::HeatingModel::CompositionalHeating< dim >, aspect::TimeStepping::RepeatOnCutback< dim >, aspect::InitialTemperature::HarmonicPerturbation< dim >, aspect::MeshRefinement::CompositionThreshold< dim >, aspect::MeshRefinement::NonadiabaticTemperatureThreshold< dim >, aspect::TerminationCriteria::EndWalltime< dim >, aspect::TerminationCriteria::UserRequest< dim >, aspect::InitialTopographyModel::PrmPolygon< dim >, aspect::Postprocess::VisualizationPostprocessors::SPD_Factor< dim >, aspect::Postprocess::CompositionVelocityStatistics< dim >, aspect::Postprocess::Topography< dim >, aspect::TerminationCriteria::SteadyHeatFlux< dim >, aspect::TerminationCriteria::SteadyRMSVelocity< dim >, aspect::MeshRefinement::VolumeOfFluidInterface< dim >, aspect::TerminationCriteria::EndStep< dim >, aspect::TerminationCriteria::SteadyTemperature< dim >, aspect::InitialTemperature::SphericalHexagonalPerturbation< dim >, aspect::MeshRefinement::ArtificialViscosity< dim >, aspect::GravityModel::RadialConstant< dim >, aspect::GravityModel::Vertical< dim >, aspect::Postprocess::RotationStatistics< dim >, aspect::TimeStepping::Function< dim >, aspect::Postprocess::MemoryStatistics< dim >, aspect::Postprocess::CoreStatistics< dim >, and aspect::Postprocess::Command< dim >.


The documentation for this class was generated from the following file: