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

Class Helmholtz

   object --+        
            |        
LinearProblem --+    
                |    
        LinearPDE --+
                    |
                   Helmholtz

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

ω*u - grad(k*grad(u)[j])[j] = f

with natural boundary conditions

k*n[j]*grad(u)[j] = g- αu

and constraints:

u=r where q>0

Instance Methods [hide private]
 
__init__(self, domain, debug=False)
Initializes a new Helmholtz 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 Helmholtz 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

setValue(self, **coefficients)

 

Sets new values to coefficients.

Parameters:
  • coefficients - new values assigned to coefficients
  • omega (any type that can be cast to a Scalar object on Function) - value for coefficient ω
  • k (any type that can be cast to a Scalar object on Function) - value for coefficient k
  • f (any type that can be cast to a Scalar object on Function) - value for right hand side f
  • alpha (any type that can be cast to a Scalar object on FunctionOnBoundary) - value for right hand side α
  • g (any type that can be cast to a Scalar object on FunctionOnBoundary) - value for right hand side g
  • r (any type that can be cast to a Scalar object on Solution or ReducedSolution depending on whether reduced order is used for the representation of the equation) - prescribed values r for the solution in constraints
  • q (any type that can be cast to a Scalar object on Solution or ReducedSolution depending on whether reduced order is used for the representation of the equation) - mask for the location of constraints
Raises:
Overrides: LinearProblem.setValue