Skip to main content

Set

Set entries in vector field

Calling example:

Interface 1​

INTERFACE
  MODULE SUBROUTINE Set1(obj, globalNode, VALUE, scale, &
    & addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    INTEGER(I4B), INTENT(IN) :: globalNode
    REAL(DFP), INTENT(IN) :: VALUE(:, :)
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set1
END INTERFACE
  • This routine sets the single entry of the vector field.
  • Here, value represents the space-time values at a node.
  • The shape of value should be same as (obj%spaceCompo, obj%timeCompo).

Interface 2​

INTERFACE
  MODULE SUBROUTINE Set2(obj, VALUE, scale, addContribution)
    CLASS(STVectorField_), TARGET, INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE(:, :)
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set2
END INTERFACE
  • This method sets all the nodal values to value
  • Here, value represents the space-time values at a node.
  • The shape of value should be same as (obj%spaceCompo, obj%timeCompo).

Interface 3​

INTERFACE
  MODULE SUBROUTINE Set3(obj, VALUE, spaceCompo, timeCompo, &
    & scale, addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE
    INTEGER(I4B), INTENT(IN) :: spaceCompo
    INTEGER(I4B), INTENT(IN) :: timeCompo
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set3
END INTERFACE
  • This method sets all the nodal values to value
  • Here, value represents the value of space-time component.

Interface 4​

INTERFACE
  MODULE SUBROUTINE Set4(obj, VALUE, scale, addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE(:, :, :)
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set4
END INTERFACE
  • This routine set all entries of space-time vector field.
  • All spatial values of all space-time components are set.
  • value denotes the space-time nodal vector.
  • shape of value is (spaceCompo, timeCompo, tNodes).

Interface 5​

INTERFACE
  MODULE SUBROUTINE Set5(obj, VALUE, spaceCompo, timeCompo,  &
    & scale, addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE(:)
    INTEGER(I4B), INTENT(IN) :: spaceCompo
    INTEGER(I4B), INTENT(IN) :: timeCompo
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set5
END INTERFACE
  • This routine sets all entries
  • The entries are selected by specifying spaceCompo and timeCompo
  • Size of value should be equal to the tNodes

Interface 6​

INTERFACE
  MODULE SUBROUTINE Set6(obj, VALUE, spaceCompo, timeCompo,  &
    & scale, addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    CLASS(ScalarField_), INTENT(IN) :: VALUE
    INTEGER(I4B), INTENT(IN) :: spaceCompo
    INTEGER(I4B), INTENT(IN) :: timeCompo
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set6
END INTERFACE
  • This routine sets all entries
  • The entries are selected by specifying spaceCompo and timeCompo
  • Size of value should be equal to the tNodes
  • Value can be an instance of child of ScalarField.

Interface 7​

INTERFACE
  MODULE SUBROUTINE Set7(obj, VALUE, globalNode, scale,  &
    & addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    INTEGER(I4B), INTENT(IN) :: globalNode(:)
    REAL(DFP), INTENT(IN) :: VALUE(:, :)
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set7
END INTERFACE
  • Set multiple entries to constant space-time values
  • value denotes the space-time value at a node
  • shape of value should be (spaceCompo, timeCompo)

Interface 8​

INTERFACE
  MODULE SUBROUTINE Set8(obj, globalNode, VALUE, scale, &
    & addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    INTEGER(I4B), INTENT(IN) :: globalNode(:)
    REAL(DFP), INTENT(IN) :: VALUE(:, :, :)
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set8
END INTERFACE

This routine sets selected entries of space-time vector field. Here globalNode contains the list of global nodes where values will be changed.

  • value is a rank-3 array in iaJ format.
    • Its first index denotes the space component,
    • second index denotes the time components
    • third component denotes the space node number.
note

The size of dimension should be equal to the size of globalNode.

  • This routine sets the selected entries.
  • Size of globalNode should be same as size(value, 3).
  • value denotes the spacet-time nodal values of globalNode.
  • number of rows in value should be spaceCompo.
  • number of columns in value should be timeCompo.

Interface 9​

INTERFACE
  MODULE SUBROUTINE Set9(obj, VALUE, globalNode, spaceCompo,  &
    & timeCompo, scale, addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE(:)
    INTEGER(I4B), INTENT(IN) :: globalNode(:)
    INTEGER(I4B), INTENT(IN) :: spaceCompo
    INTEGER(I4B), INTENT(IN) :: timeCompo
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set9
END INTERFACE
  • This routine sets the multiple values of a space-time component.
  • Size of value should be equal to size of globalNode.

Interface 10​

INTERFACE
  MODULE SUBROUTINE Set10(obj, VALUE, globalNode, spaceCompo, &
    & timeCompo, scale, addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE
    INTEGER(I4B), INTENT(IN) :: globalNode
    INTEGER(I4B), INTENT(IN) :: spaceCompo
    INTEGER(I4B), INTENT(IN) :: timeCompo
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set10
END INTERFACE
  • This routine sets a single entry of space-time component

Interface 11​

INTERFACE
  MODULE SUBROUTINE Set11(obj, VALUE, istart, iend, stride,  &
    & scale, addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    INTEGER(I4B), INTENT(IN) :: istart
    INTEGER(I4B), INTENT(IN) :: iend
    INTEGER(I4B), INTENT(IN) :: stride
    REAL(DFP), INTENT(IN) :: VALUE(:, :)
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set11
END INTERFACE
  • Sets multiple values using triplets.
  • value denotes the space-time values at a single node.
  • Shape of value should be (spaceCompo, timeCompo).

Interface 12​

INTERFACE
  MODULE SUBROUTINE Set12(obj, VALUE, istart, iend, stride,  &
    & scale, addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE(:, :, :)
    INTEGER(I4B), INTENT(IN) :: istart
    INTEGER(I4B), INTENT(IN) :: iend
    INTEGER(I4B), INTENT(IN) :: stride
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set12
END INTERFACE
  • Sets multiple values using triplets.
  • value denotes the space-time values at several nodes.
  • value(:,:,i) denotes the space-time value at ith node.
  • Shape of value(:,:,i) should be (spaceCompo, timeCompo).

Interface 13​

INTERFACE
  MODULE SUBROUTINE Set13(obj, VALUE, globalNode, scale, &
    & addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    TYPE(FEVariable_), INTENT(IN) :: VALUE
    INTEGER(I4B), INTENT(IN) :: globalNode(:)
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set13
END INTERFACE
  • Set multiple values by using FEVariable.
  • FEVariable, value, should be of SpaceTime type

Interface 14​

INTERFACE
  MODULE SUBROUTINE Set14(obj, VALUE, scale, addContribution)
    CLASS(STVectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE Set14
END INTERFACE
  • Sets all values to a given scalar value.