Initiate

Initiate an instance of DOF.

Interface

We can construct DOF_ object by calling the Initiate() subroutine.

Initiate

INTERFACE
MODULE PURE SUBROUTINE Initiate( obj, tNodes, Names, spacecompo, &
  & timecompo, StorageFMT )
  CLASS( DOF_ ), INTENT( INOUT ) :: obj
    !! degree of freedom object
  INTEGER( I4B ), INTENT( IN ) :: tNodes( : )
    !! number of nodes for each physical variable
  CHARACTER( LEN = 1 ), INTENT( IN ) :: Names( : )
    !! Names of each physical variable
  INTEGER( I4B ), INTENT( IN ) :: spacecompo( : )
    !! Space component of each physical variable
  INTEGER( I4B ), INTENT( IN ) :: timecompo( : )
    !! Time component of each physical variable
  INTEGER( I4B ), INTENT( IN ) :: StorageFMT
    !! Storage format `FMT_DOF`, `FMT_Nodes`
END SUBROUTINE Initiate
END INTERFACE

where,

• tNodes denotes the total number of nodes in each physical variables
• Names is the name of each physical variables
• SpaceCompo is the number of spatial components in each physical variable, if a physical variable is scalar then one can use also use -1 instead of 1 for the total number of space components
• TimeCompo is the number of time components in each physical variables
• StorageFMT is the storage format, it can be FMT_DOF or FMT_Nodes

info

The size of tNodes, Names, SpaceCompo, TimeCompo vectors should be equal to the total number of physical variables.

܀ See example

This example show how to use .tNames., .tNodes., and .tDOF..

PROGRAM main
    USE easifemBase
    IMPLICIT NONE
    TYPE( DOF_ ) :: obj

Initiate DOF (interface 1)

    CALL Initiate( obj, tNodes=[10], names=["U"], spaceCompo=[3],  &
      & timeCompo=[1], storageFMT = FMT_DOF )

Display DOF object

    CALL Display( obj, "obj : " )

Get total names

    CALL OK( (.tNames. obj) .EQ. 1, '.tNames. obj : ' )

Get total number of nodes

    CALL OK( (.tNodes. obj) .EQ. 30, '.tNodes. obj : ' )

Get total degrees of freedom

    CALL OK( (.tDOF. obj) .EQ. 3, '.tDOF. obj : ' )

cleanup

    CALL Deallocate( obj )
END PROGRAM main

↢

Interfaces for constructing vectors using DOF

The Initiate() method has been extended for constructing

• Rank-1 fortran arrays
• RealVector_
• Vector of RealVector_.

This topic is covered below.

Constructing navtive vectors

܀ See Interface

Interface

INTERFACE
MODULE PURE SUBROUTINE Initiate( val, obj )
  REAL( DFP ), ALLOCATABLE, INTENT( INOUT ) :: val( : )
    !! This vector will be initiated by using obj
  CLASS( DOF_ ), INTENT( IN ) :: obj
    !! DOF object
END SUBROUTINE Initiate
END INTERFACE

܀ See example

This example show how to create an instance of DOF_ and use it to create a vector of reals.

• DOF/Initiate
• DOF/tNames
• DOF/tNodes
• DOF/tDOF

PROGRAM main
    USE easifemBase
    IMPLICIT NONE
    TYPE( DOF_ ) :: obj
    REAL( DFP ), ALLOCATABLE :: val( : )

Initiate interface 1

    CALL Initiate( obj, tNodes=[10], names=["U"], spaceCompo=[3],  &
      & timeCompo=[1], storageFMT = FMT_DOF )

Initiate a real vector using DOF_ object.

    CALL Initiate( Val=val, obj=obj )

Display DOF object

    CALL Display( obj, "CALL Initiate( Val=val, obj=obj ) : " )

cleanup

    CALL Deallocate( obj )
END PROGRAM main

↢

Constructing RealVector

܀ Interface

️܀ See example

This example show how to initiate an instance of DOF_ and use it to create an instance of RealVector_.

• DOF/Initiate
• DOF/tNames
• DOF/tNodesss
• DOF/tDOF

PROGRAM main
  USE easifemBase
  IMPLICIT NONE
  TYPE( DOF_ ) :: obj
  TYPE(RealVector_) :: val

Create an instance of [[DOF_]]

Initiate DOF

  CALL Initiate( obj, tNodes=[10], names=["U"], spaceCompo=[3],  &
    & timeCompo=[1], storageFMT = FMT_DOF )

Initiate a vector of real using an instance of [[DOF_]]

Initiate RealVector_

  CALL Initiate( Val=val, obj=obj )

Display RealVector_

  CALL Display( Val, "CALL Initiate( Val=val, obj=obj ) : " )

Cleanup

  CALL Deallocate( obj )
END PROGRAM main

↢

Constructing vector of RealVector

܀ Interface

️܀ See example

This example shows how to initiate an instance of DOF_, then use it to create a vector of reals RealVector_.

• DOF/Initiate
• DOF/tNames
• DOF/tNodesss
• DOF/tDOF

Note that in Line 5 we have vector of [[RealVector_]]

PROGRAM main
  USE easifemBase
  IMPLICIT NONE
  TYPE( DOF_ ) :: obj
  TYPE(RealVector_), ALLOCATABLE :: val( : )

Initiate DOF

  CALL Initiate( obj, tNodes=[10], names=["U"], spaceCompo=[3],  &
    & timeCompo=[1], storageFMT = FMT_DOF )

Initiate RealVector

  CALL Initiate( Val=val, obj=obj )

Display RealVector

  CALL Display( Val, "CALL Initiate( Val=val, obj=obj ) : " )

cleanup

  CALL Deallocate( obj )
END PROGRAM main

↢

Assignment(=)

We can use an assignment operator to copy the contents of one DOF_ object into another DOF_ object.

܀ See example

This example shows the usage of assignment operator to construct an instance of DOF_.

PROGRAM main
  USE easifemBase
  IMPLICIT NONE
  TYPE( DOF_ ) :: obj, anotherObj

Initiate DOF

  CALL Initiate( obj, tNodes=[10], names=["U"], spaceCompo=[3],  &
    & timeCompo=[1], storageFMT = FMT_DOF )

Initiate by Assignment

  anotherObj=obj

Display anotherObj

  CALL Display( anotherObj, "anotherObj=obj : " )

cleanup

  CALL Deallocate( obj )
  CALL Deallocate( anotherObj )
END PROGRAM main

↢

DOF Function

We can also use DOF() function for the constructing the DOF object.

܀ See example

This example show how to initiate an instance of [[DOF_]] by using the constructor function DOF() .

• DOF/DOF

PROGRAM main
  USE easifemBase
  IMPLICIT NONE
  TYPE( DOF_ ) :: obj

Constructor using DOF()

  obj = DOF( tNodes=[10], names=["U"], spaceCompo=[3],  &
    & timeCompo=[1], storageFMT = FMT_DOF )

Display content

  CALL Display( obj, "DOF() : " )

cleanup

  CALL Deallocate( obj )
END PROGRAM main

↢

DOF_Pointer

We can also use DOF_Pointer() function for get a pointer to a newly created an instance of DOF_.

܀ See example

This example show how to initiate an instance of [[DOF_]] by using DOF_Pointer.

PROGRAM main
    USE easifemBase
    IMPLICIT NONE
    TYPE( DOF_ ), POINTER :: obj

Constructing by DOF_Pointer()

    obj => DOF_POINTER( tNodes=[10], names=["U"], spaceCompo=[3],  &
      & timeCompo=[1], storageFMT = FMT_DOF )

Display DOF

    CALL Display( obj, "DOF() : " )

cleanup

    CALL Deallocate( obj )
END PROGRAM main

↢