The Conley-Morse Graphs Software
Public Member Functions | List of all members
MapPeriodic Class Reference

This class defines a sample periodic map on a multi-dimensional torus which may be used for testing the capability of the software to deal with periodic boundary conditions. More...

#include <m_periodic.h>

Inheritance diagram for MapPeriodic:
MapType

Public Member Functions

 MapPeriodic ()
 The default constructor. More...
 
void compute (const double *xleft, const double *xright, double *yleft, double *yright, int dim, const spcCoord *coord, int subdiv) const
 Computes the image of a box whose left and right coordinates are given. More...
 
- Public Member Functions inherited from MapType
 MapType ()
 The default constructor of an object which describes a map. More...
 
virtual ~MapType ()
 The destructor of an object which describe a map. More...
 
virtual void setParam (const double *left, const double *right, int n)
 Sets the parameters to the given intervals defined by their left and right coordinates. More...
 
const double & getLeftParam (int n) const
 Returns the left value of the given parameter. More...
 
const double & getRightParam (int n) const
 Returns the right value of the given parameter. More...
 
virtual void compute (const double *xleft, const double *xright, double *yleft, double *yright, int dim, const spcCoord *coord, int subdiv) const =0
 Computes the image of a box whose left and right coordinates are given. More...
 
void operator() (const IntervalType *x, IntervalType *y, int dim, const spcCoord *coord, int subdiv) const
 An interface to the function 'compute' based on intervals. More...
 
bool adjust (bool successful, int subdiv)
 Adjusts parameters if necessary after a successful computation or after an unsuccessful computation of the graph of the map at a specific subdivision level. More...
 
std::string getOptInfo () const
 Gets a single line of information on optimization of the computation of the map, so that it can be used by maps created for the same and nearby parameter values. More...
 
void useOptInfo (const std::string &info)
 Uses a prevously saved line of information on optimization of the computation of the map for the same or nearby parameter values. More...
 
void saveInternals (chomp::multiwork::mwData &data) const
 Saves the internal parameters and other data of the map to the mwData structure. More...
 
void loadInternals (chomp::multiwork::mwData &data)
 Retrieves the internal paramters and other data of the map from the mwData structure. More...
 
virtual double getTimeStep (int subdiv) const
 Returns the time step, which is 1 for a map, or the time t of integration in case of a time-t map of a flow. More...
 
virtual std::string name () const
 Returns the name of the map. More...
 

Detailed Description

This class defines a sample periodic map on a multi-dimensional torus which may be used for testing the capability of the software to deal with periodic boundary conditions.

The map is defined on the interval [0,1].

Definition at line 51 of file m_periodic.h.

Constructor & Destructor Documentation

◆ MapPeriodic()

MapPeriodic::MapPeriodic ( )
inline

The default constructor.

Definition at line 68 of file m_periodic.h.

References testIntervals().

Member Function Documentation

◆ compute()

void MapPeriodic::compute ( const double *  xleft,
const double *  xright,
double *  yleft,
double *  yright,
int  dim,
const spcCoord coord,
int  subdiv 
) const
inlinevirtual

Computes the image of a box whose left and right coordinates are given.

Fills in the images with the left and right coordinates of the image box.

Implements MapType.

Definition at line 74 of file m_periodic.h.

References resetRounding().


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