ESYS13  Revision_
Public Member Functions | Private Member Functions | Private Attributes
escript::AbstractTransportProblem Class Reference

Give a short description of what AbstractTransportProblem does. More...

#include <AbstractTransportProblem.h>

List of all members.

Public Member Functions

 AbstractTransportProblem ()
 Default constructor for AbstractTransportProblem.
 AbstractTransportProblem (const int blocksize, const FunctionSpace &functionspace)
virtual ~AbstractTransportProblem ()
 Destructor.
int isEmpty () const
FunctionSpace getFunctionSpace () const
 returns the column function space
int getBlockSize () const
 returns the block size
Data solve (Data &u0, Data &source, const double dt, boost::python::object &options) const
 returns the solution u for a time step dt>0 with initial value u0 at time t=0
virtual void resetTransport () const
 resets the transport operator typically as they have been updated.
void insertConstraint (Data &source, Data &q, Data &r) const
 inserts constraint u_{,t}=r where q>0 into the problem
virtual double getSafeTimeStepSize () const
virtual double getUnlimitedTimeStepSize () const

Private Member Functions

virtual void setToSolution (Data &out, Data &u0, Data &source, const double dt, boost::python::object &options) const
 sets solution out by time step dt.
virtual void copyConstraint (Data &source, Data &q, Data &r) const
 copy constraint u_{,t}=r where q>0 into the problem it can be assumed that q and r are not empty and have appropriate shape and function space.

Private Attributes

int m_empty
int m_blocksize
FunctionSpace m_functionspace

Detailed Description

Give a short description of what AbstractTransportProblem does.

Description: Give a detailed description of AbstractTransportProblem

Template Parameters: For templates describe any conditions that the parameters used in the template must satisfy


Constructor & Destructor Documentation

Default constructor for AbstractTransportProblem.

Description: Default constructor for AbstractTransportProblem

Preconditions: Describe any preconditions

Throws: Describe any exceptions thrown

References m_empty.

escript::AbstractTransportProblem::AbstractTransportProblem ( const int  blocksize,
const FunctionSpace functionspace 
)

References m_blocksize, and m_empty.

Destructor.


Member Function Documentation

void escript::AbstractTransportProblem::copyConstraint ( Data source,
Data q,
Data r 
) const [private, virtual]

copy constraint u_{,t}=r where q>0 into the problem it can be assumed that q and r are not empty and have appropriate shape and function space.

Referenced by insertConstraint().

returns the block size

References isEmpty(), and m_blocksize.

Referenced by insertConstraint(), and solve().

returns the column function space

References isEmpty(), and m_functionspace.

Referenced by insertConstraint(), and solve().

Referenced by BOOST_PYTHON_MODULE().

Referenced by BOOST_PYTHON_MODULE().

void escript::AbstractTransportProblem::insertConstraint ( Data source,
Data q,
Data r 
) const

resets the transport operator typically as they have been updated.

Referenced by BOOST_PYTHON_MODULE().

void escript::AbstractTransportProblem::setToSolution ( Data out,
Data u0,
Data source,
const double  dt,
boost::python::object &  options 
) const [private, virtual]

sets solution out by time step dt.

Referenced by solve().

Data escript::AbstractTransportProblem::solve ( Data u0,
Data source,
const double  dt,
boost::python::object &  options 
) const

returns the solution u for a time step dt>0 with initial value u0 at time t=0

References getBlockSize(), escript::Data::getDataPointSize(), getFunctionSpace(), escript::Data::getFunctionSpace(), isEmpty(), and setToSolution().

Referenced by BOOST_PYTHON_MODULE().


Member Data Documentation

Referenced by getFunctionSpace().


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