Scrambler  1
PointGravitySrc Module Reference
+ Collaboration diagram for PointGravitySrc:

List of all members.

Data Types

type  PointGravityDef
type  pPointGravityDef
 Pointer Nesting Type. More...

Public Member Functions

subroutine, public PointGravityInit ()
subroutine, public CheckParticlePositions ()
subroutine, public PointGravity (q, dt, x, t, dv, level, lform)
subroutine, public PointGravity_inst (q, dqdt, x, t, lform)
REAL(KIND=qPREC) function, public PointGravityPotential (PointGravityObj, pos, t)
subroutine, public CreatePointGravityObject (PointGravityObj)
subroutine, public DestroyPointGravityObject (PointGravityObj, id)
INTEGER function, public PointGravity_CountObjects ()
 Returns the number of point gravity source term objects.
subroutine, public FindPointGravityObject (id, gravity_object)
 Returns a pointer to the gravity object indicated by the ID, or a null pointer if the ID is invalid.
subroutine, public PointGravity_InitChomboDatasets (chandle, obj_count)
 Initializes the datasets required to store point gravity source objects in a Chombo file.
subroutine, public PointGravity_WriteObjectToChombo (chandle, gravity_object)
 Writes the data for a single point gravity source object to a Chombo file.
subroutine, public PointGravity_ReadObjectFromChombo (chandle, gravity_object)
 Read the data for a single point gravity object in from a Chombo file.

Public Attributes

TYPE(PointGravityDef), pointer,
public 
FirstPointGravityObj
TYPE(PointGravityDef), pointer,
public 
LastPointGravityObj

Private Member Functions

subroutine AddPointGravityObjToList (PointGravityObj)
subroutine RemovePointGravityObjFromList (PointGravityObj)

Private Attributes

INTEGER nPointGravityObjects

Detailed Description

Definition at line 23 of file pointgravity.f90.


Member Function/Subroutine Documentation

subroutine, public PointGravityInit ( )

Definition at line 60 of file pointgravity.f90.

subroutine, public CheckParticlePositions ( )

Definition at line 65 of file pointgravity.f90.

subroutine, public PointGravity ( REAL(KIND=qPrec), dimension(:)  q,
REAL(KIND=qPrec)  dt,
REAL(KIND=qPrec), dimension(3)  x,
REAL(KIND=qPrec)  t,
REAL(KIND=qPrec)  dv,
INTEGER  level,
LOGICAL  lform 
)

Definition at line 77 of file pointgravity.f90.

subroutine, public PointGravity_inst ( REAL(KIND=qPrec), dimension(:)  q,
REAL(KIND=qPrec), dimension(:)  dqdt,
REAL(KIND=qPrec), dimension(3)  x,
REAL(KIND=qPrec)  t,
LOGICAL  lform 
)

Definition at line 117 of file pointgravity.f90.

REAL(KIND=qPREC) function, public PointGravityPotential ( TYPE(PointGravityDef PointGravityObj,
REAL(KIND=qPREC), dimension(3)  pos,
REAL(KIND=qPREC)  t 
)

Definition at line 157 of file pointgravity.f90.

subroutine, public CreatePointGravityObject ( TYPE(PointGravityDef), pointer  PointGravityObj)

Definition at line 171 of file pointgravity.f90.

subroutine, public DestroyPointGravityObject ( TYPE(PointGravityDef), pointer  PointGravityObj,
INTEGER, optional  id 
)

Definition at line 188 of file pointgravity.f90.

subroutine AddPointGravityObjToList ( TYPE(PointGravityDef), pointer  PointGravityObj) [private]

Definition at line 207 of file pointgravity.f90.

subroutine RemovePointGravityObjFromList ( TYPE(PointGravityDef), pointer  PointGravityObj) [private]

Definition at line 220 of file pointgravity.f90.

INTEGER function, public PointGravity_CountObjects ( )

Returns the number of point gravity source term objects.

Definition at line 240 of file pointgravity.f90.

subroutine, public FindPointGravityObject ( INTEGER  id,
TYPE(PointGravityDef), pointer  gravity_object 
)

Returns a pointer to the gravity object indicated by the ID, or a null pointer if the ID is invalid.

Parameters:
idAn integer value (the ID of the point gravity object being sought)

Definition at line 261 of file pointgravity.f90.

subroutine, public PointGravity_InitChomboDatasets ( TYPE(ChomboHandle), pointer  chandle,
INTEGER  obj_count 
)

Initializes the datasets required to store point gravity source objects in a Chombo file.

Parameters:
chandleA chombo file handle.
obj_countThe number of objects stour

Definition at line 289 of file pointgravity.f90.

subroutine, public PointGravity_WriteObjectToChombo ( TYPE(ChomboHandle), pointer  chandle,
TYPE(PointGravityDef), pointer  gravity_object 
)

Writes the data for a single point gravity source object to a Chombo file.

Parameters:
chandleA chombo file handle.
gravity_objectA pointer to a point gravity source object.

Definition at line 335 of file pointgravity.f90.

subroutine, public PointGravity_ReadObjectFromChombo ( TYPE(ChomboHandle), pointer  chandle,
TYPE(PointGravityDef), pointer  gravity_object 
)

Read the data for a single point gravity object in from a Chombo file.

Parameters:
chandleAn active Chombo file handle object.
gravity_objectAn allocated PointGravityDef object.

Definition at line 409 of file pointgravity.f90.


Member Data Documentation

TYPE(PointGravityDef), pointer, public FirstPointGravityObj

Definition at line 50 of file pointgravity.f90.

TYPE(PointGravityDef), pointer, public LastPointGravityObj

Definition at line 50 of file pointgravity.f90.

INTEGER nPointGravityObjects [private]

Definition at line 51 of file pointgravity.f90.


The documentation for this module was generated from the following file:
 All Classes Files Functions Variables