Package esys :: Package escript :: Module linearPDEs :: Class Poisson
[hide private]
[frames] | no frames]

Class Poisson

   object --+        
            |        
LinearProblem --+    
                |    
        LinearPDE --+
                    |
                   Poisson

Class to define a Poisson equation problem. This is generally a LinearPDE of the form

-grad(grad(u)[j])[j] = f

with natural boundary conditions

n[j]*grad(u)[j] = 0

and constraints:

u=0 where q>0

Instance Methods [hide private]
 
__init__(self, domain, debug=False)
Initializes a new Poisson equation.
Data
getCoefficient(self, name)
Returns the value of the coefficient name of the general PDE.
 
setValue(self, **coefficients)
Sets new values to coefficients.

Inherited from LinearPDE: __str__, checkSymmetry, createOperator, getFlux, getRequiredOperatorType, getResidual, getSolution, getSystem, insertConstraint

Inherited from LinearProblem: alteredCoefficient, checkReciprocalSymmetry, checkSymmetricTensor, createCoefficient, createRightHandSide, createSolution, getCurrentOperator, getCurrentRightHandSide, getCurrentSolution, getDim, getDomain, getDomainStatus, getFunctionSpaceForCoefficient, getFunctionSpaceForEquation, getFunctionSpaceForSolution, getNumEquations, getNumSolutions, getOperator, getOperatorType, getRightHandSide, getShapeOfCoefficient, getSolverOptions, getSystemStatus, hasCoefficient, initializeSystem, introduceCoefficients, invalidateOperator, invalidateRightHandSide, invalidateSolution, invalidateSystem, isOperatorValid, isRightHandSideValid, isSolutionValid, isSymmetric, isSystemValid, isUsingLumping, reduceEquationOrder, reduceSolutionOrder, resetAllCoefficients, resetOperator, resetRightHandSide, resetSolution, setDebug, setDebugOff, setDebugOn, setReducedOrderForEquationOff, setReducedOrderForEquationOn, setReducedOrderForEquationTo, setReducedOrderForSolutionOff, setReducedOrderForSolutionOn, setReducedOrderForSolutionTo, setReducedOrderOff, setReducedOrderOn, setReducedOrderTo, setSolution, setSolverOptions, setSymmetry, setSymmetryOff, setSymmetryOn, setSystemStatus, trace, validOperator, validRightHandSide, validSolution

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, domain, debug=False)
(Constructor)

 

Initializes a new Poisson equation.

Parameters:
  • domain (Domain) - domain of the PDE
  • debug - if True debug information is printed
Overrides: object.__init__

getCoefficient(self, name)

 

Returns the value of the coefficient name of the general PDE.

Parameters:
  • name (string) - name of the coefficient requested
Returns: Data
the value of the coefficient name
Raises:
Overrides: LinearProblem.getCoefficient

Note: This method is called by the assembling routine to map the Poisson equation onto the general PDE.

setValue(self, **coefficients)

 

Sets new values to coefficients.

Parameters:
  • coefficients - new values assigned to coefficients
  • f (any type that can be cast to a Scalar object on Function) - value for right hand side f
  • q (any type that can be cast to a rank zero Data object on Solution or ReducedSolution depending on whether reduced order is used for the representation of the equation) - mask for location of constraints
Raises:
Overrides: LinearProblem.setValue