Skip to main content

Set

Set entries in vector field

Calling example:

Interface 1​

 INTERFACE
  MODULE SUBROUTINE vField_set1(obj, globalNode, VALUE, &
    & scale, addContribution)
    CLASS(VectorField_), 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 vField_set1
END INTERFACE

This routine sets the single entry of the vector field.

Here, value should be a vector representing the components of a vector.

The size of value should be same as obj%spaceCompo.

In simple words it does following.

vector( 1:spaceCompo, globalNode ) = value( 1:spaceCompo )

Interface 2​

INTERFACE
  MODULE SUBROUTINE vField_set2(obj, VALUE, scale, addContribution)
    CLASS(VectorField_), TARGET, INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE(:)
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE vField_set2
END INTERFACE
  • This method sets all the nodal values to value
  • The size of value should be same as the obj%spaceCompo
vector( 1:spaceCompo, i ) = value( 1:spaceCompo ), for i = 1, tNodes

Interface 3​

 INTERFACE
 MODULE SUBROUTINE vField_set3(obj, VALUE, spaceCompo, scale, addContribution)
    CLASS(VectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE
    INTEGER(I4B), INTENT(IN) :: spaceCompo
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE vField_set3
END INTERFACE
  • This routine sets all values of spaceCompo component of the vector field to a given scalar value value.
vector( spaceCompo, i ) = value, for i = 1, tNodes

Interface 4​

 INTERFACE
  MODULE SUBROUTINE vField_set4(obj, VALUE, scale, addContribution)
    CLASS(VectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE(:, :)
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE vField_set4
END INTERFACE
  • This routine set all entries of vector field to given vector
  • Here shape of should be value(1:spaceCompo, tNodes).
vector( :, : ) = value( :, : )

Interface 5​

 INTERFACE
 MODULE SUBROUTINE vField_set5(obj, VALUE, spaceCompo, scale, addContribution)
    CLASS(VectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE(:)
    INTEGER(I4B), INTENT(IN) :: spaceCompo
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE vField_set5
END INTERFACE
  • This routine sets all entries of the component spaceCompo of VectorField to a given fortran vector value
vector( spaceCompo, : ) = value( : )
  • The size of value should be equal to the tNodes.

Interface 6​

INTERFACE
 MODULE SUBROUTINE vField_set6(obj, VALUE, spaceCompo, scale, addContribution)
    CLASS(VectorField_), INTENT(INOUT) :: obj
    TYPE(ScalarField_), INTENT(IN) :: VALUE
    INTEGER(I4B), INTENT(IN) :: spaceCompo
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE vField_set6
END INTERFACE
  • This routine sets all entries of the component spaceCompo of VectorField to a given ScalarField value
vector( spaceCompo, : ) = value

Interface 7​

INTERFACE
 MODULE SUBROUTINE vField_set7(obj, VALUE, globalNode, scale, addContribution)
    CLASS(VectorField_), 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 vField_set7
END INTERFACE
  • This soubroutine sets the selected enties to a vector entry value( : )
  • Size of value should be equal to the obj%spaceCompo
Effectively it does the following:
vector( :, globalNode ) = value( : ), for entries in global nodes

Interface 8​

INTERFACE
  MODULE SUBROUTINE vField_set8(obj, globalNode, VALUE, scale, &
    & addContribution)
    CLASS(VectorField_), INTENT(INOUT) :: obj
    INTEGER(I4B), INTENT(IN) :: globalNode(:)
    REAL(DFP), INTENT(IN) :: VALUE(:, :)
  !! value is in value(i,J) format.
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE vField_set8
END INTERFACE
  • This routine sets the selected entries.
 vector( :, globalNode ) = value( :, : )

Interface 9​

 INTERFACE
  MODULE SUBROUTINE vField_set9(obj, VALUE, globalNode, spaceCompo, scale, &
    & addContribution)
    CLASS(VectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE(:)
    INTEGER(I4B), INTENT(IN) :: globalNode(:)
    INTEGER(I4B), INTENT(IN) :: spaceCompo
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE vField_set9
END INTERFACE
  • This routine sets the multiple values
  • Size of value should be equal to size of globalNode
vector( spaceCompo, globalNode ) = value( : )

Interface 10​

 INTERFACE
  MODULE SUBROUTINE vField_set10(obj, VALUE, globalNode, spaceCompo, scale, &
    & addContribution)
    CLASS(VectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE
    INTEGER(I4B), INTENT(IN) :: globalNode
    INTEGER(I4B), INTENT(IN) :: spaceCompo
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE vField_set10
END INTERFACE
  • This routine sets a single entry

Interface 11​

 INTERFACE
  MODULE SUBROUTINE vField_set13(obj, VALUE, globalNode, scale, &
    & addContribution)
    CLASS(VectorField_), 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 vField_set13
END INTERFACE

Sets the multiple values using FEVariable.

Interface 12​

INTERFACE
  MODULE SUBROUTINE vField_set12(obj, VALUE, istart, iend, stride, scale, &
    & addContribution)
    CLASS(VectorField_), 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 vField_set12
END INTERFACE

Interface 13​

 INTERFACE
  MODULE SUBROUTINE vField_set13(obj, VALUE, globalNode, scale, &
    & addContribution)
    CLASS(VectorField_), 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 vField_set13
END INTERFACE

Interface 14​

 INTERFACE
  MODULE SUBROUTINE vField_set14(obj, VALUE, scale, addContribution)
    CLASS(VectorField_), INTENT(INOUT) :: obj
    REAL(DFP), INTENT(IN) :: VALUE
    REAL(DFP), OPTIONAL, INTENT(IN) :: scale
    LOGICAL(LGT), OPTIONAL, INTENT(IN) :: addContribution
  END SUBROUTINE vField_set14
END INTERFACE
  • Sets all values