Skip to main content

Motion Standalone Preprocessor C# library 2025 R2

Class HydroForce

Last update: 16.07.2025

Namespace: VM.Managed.DAFUL.Track
Assembly: VMDTrackBase.dll

This class is to represent the hydro force.

public class HydroForce : Entity<propertyhydroforce>, IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IHistoryObjectSerializable, IAttributeContainer, IContainer, IEntity, IEntityBase, IObjectBase, IObject, ILinkContainer, IOwned, IHasID, IEventProvider, IHasKeyObject, IHasName, IEnabled, IHasComment, IVisible, IDocumentOwner, INamed, INavigatorItem, IVisible, IMultiChangable, IHasProperty, IGroup, IDraw, IDrawIcon, IReferencable, IHydroForce, IHasOtherEntityInSameCategory, IReportable, IHasReplaceableEntity

Inheritance

object ← ObservableObject ← LinkableBase ← ObjectBase ← Object ← ContainerObject ← EntityBase ← EntityHydroForce

Implements

IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IHistoryObjectSerializable, IAttributeContainer, IContainer, IEntity, IEntityBase, IObjectBase, IObject, ILinkContainer, IOwned, IHasID, IEventProvider, IHasKeyObject, IHasName, IEnabled, IHasComment, IVisible, IDocumentOwner, INamed, INavigatorItem, IVisible, IMultiChangable, IHasProperty, IGroup, IDraw, IDrawIcon, IReferencable, IHydroForce, IHasOtherEntityInSameCategory, IReportable, IHasReplaceableEntity

Inherited Members

Entity.Initialize(Unit.ConvertFactor), Entity.GetUnnamedObjectName(object), Entity.FindLocal(string), Entity.Property, EntityBase.Initialize(Unit.ConvertFactor), EntityBase.SetOldNameWithNewEntity(ObjectBase, ObjectBase), EntityBase.PropertyRequestUpdate(object, LinkEventArgs), EntityBase.OnDeserializationForAttribute(), EntityBase.OnUpdatePropertyImpl(Property, LinkEventArgs), EntityBase.LinkRequestDestroying(object, LinkEventArgs), EntityBase.GetModelNavigatorInformationImpl(XmlDocument, XmlElement, bool), EntityBase.FixUp(ObjectBase), EntityBase.FindLocal(string), EntityBase.WriteTemplateImpl(XmlWriter), EntityBase.ReadTemplateImpl(XmlReader), EntityBase.LinkAddedToDocument(object, AddToDocEventArgs), EntityBase.OnDeserialization(object), EntityBase.Name, EntityBase.FullName, EntityBase.NonSymmetricName, EntityBase.DisplayName, EntityBase.IsEnabled, EntityBase.Comment, EntityBase.HasLayerExplicitly, EntityBase.UntypedProperty, EntityBase.IsFileProperty, EntityBase.Layer, EntityBase.IsVisible, ContainerObject.Find(string), ContainerObject.FindLocal(string), ContainerObject.GetUnnamedObjectName(object), ContainerObject.GetNewEntityName(string), ContainerObject.GetNewEntityName(string, bool, int), ContainerObject.GetNewEntityName(string, bool, int, int), Object.GetKey(), Object.Initialize(Unit.ConvertFactor), Object.SetIconColor(Canvas), Object.OnDeserialization(object), Object.CustomGetObjectData(SerializationInfo, StreamingContext), Object.RollbackEvent(), Object.OnDeserializedCore(object), Object.Key, Object.UntypedEventCore, Object.EventCore, Object.Attributes, ObjectBase.ReplaceEventCore(ObjectEventCore), ObjectBase.SetModifiedCore(ModifiedResult.ModifiedType), ObjectBase.AddPostDeserialize(StreamingContext), ObjectBase.LinkAddedToDocumentCore(IOwned, bool), ObjectBase.SetModified(ModifiedResult.ModifiedType), ObjectBase.SetModified(), ObjectBase.SetModified(ModifiedResult.ModifiedType, IDocument), ObjectBase.DestroyObject(object, LinkEventArgs), ObjectBase.DestroyObject(DestroyEventArgs), ObjectBase.DestroyObject(), ObjectBase.Initialize(Unit.ConvertFactor), ObjectBase.FixUp(ObjectBase), ObjectBase.DoWorkAfterUpdateContents(), ObjectBase.SetOldNameWithNewEntity(ObjectBase, ObjectBase), ObjectBase.SetIconColor(Canvas), ObjectBase.RemoveFromCreatedList(), ObjectBase.PostAddToDocument(), ObjectBase.PostRemoveFromDocument(Document), ObjectBase.GetArgumentList(LinkedList), ObjectBase.ResetInvalidEntity(), ObjectBase.OnDeserialization(object), ObjectBase.IsSerializableEvent(Delegate), ObjectBase.CustomGetObjectData(SerializationInfo, StreamingContext), ObjectBase.CheckAndUpdateLink(HashSet), ObjectBase.Verify(VerifiedResult), ObjectBase.ConnectProxy(), ObjectBase.RollbackEvent(), ObjectBase.LinkRequestUpdating(object, LinkEventArgs), ObjectBase.LinkRequestUpdate(object, LinkEventArgs), ObjectBase.LinkRequestDestroying(object, LinkEventArgs), ObjectBase.LinkRequestDestroy(object, LinkEventArgs), ObjectBase.LinkAddedToDocument(object, AddToDocEventArgs), ObjectBase.LinkRemovedFromDocument(object, RemoveFromDocEventArgs), ObjectBase.DisposeManagedResources(), ObjectBase.GetDestroyEventExtraData(), ObjectBase.OnLinkReserved(ILink, object, EventArgs), ObjectBase.CreateEntityWhenUpdateContents(Action), ObjectBase.GetObjectByKey(UIntPtr), ObjectBase.FindObjectOnXmlDeserialize(string), ObjectBase.UpdateContents(XmlReader, ObjectBase, string), ObjectBase.UpdateContents(XmlReader, ObjectBase), ObjectBase.UpdateContents(string, string), ObjectBase.UpdateContents(string), ObjectBase.SetFlagWhenXMLFile(string, bool), ObjectBase.IsEqualArray(T[], T[]), ObjectBase.IsEqualList(List, List), ObjectBase.SetContainer(IOwned, bool), ObjectBase.GetTargetListForUpdate(), ObjectBase.SkipUpdateObjectImpl(), ObjectBase.raise_OnUpdating(object, LinkEventArgs), ObjectBase.raise_OnUpdate(object, LinkEventArgs), ObjectBase.raise_OnDestroying(object, LinkEventArgs), ObjectBase.raise_OnDestroy(object, LinkEventArgs), ObjectBase.raise_Destroying(object, Identifier), ObjectBase.raise_OnAdded(object, AddToDocEventArgs), ObjectBase.raise_OnRemoved(object, RemoveFromDocEventArgs), ObjectBase.raise_OnContentsUpdated(object, EventArgs), ObjectBase.Dispose(bool), ObjectBase.SkipModified, ObjectBase.ClearChildInfoBeforeDeserialize, ObjectBase.KeyImpl, ObjectBase.ID, ObjectBase.TopologyEntityTypeName, ObjectBase.ObjectStateForCircularError, ObjectBase.ObjectState, ObjectBase.IsChildExternable, ObjectBase.IsExternable, ObjectBase.Container, ObjectBase.Owner, ObjectBase.Document, ObjectBase.UntypedEventCore, ObjectBase.KernelKey, ObjectBase.Key, ObjectBase.OnContentsUpdated, ObjectBase.OnRemoved, ObjectBase.OnAdded, ObjectBase.Destroying, ObjectBase.OnDestroy, ObjectBase.OnDestroying, ObjectBase.OnUpdate, ObjectBase.OnUpdating, LinkableBase.OnDeserialization(object), ObservableObject.Dispose(), ObservableObject.RaisePropertyChanged(string), ObservableObject.RaisePropertyChanged(string, object, object), ObservableObject.Dispose(bool), ObservableObject.DisposeManagedResources(), ObservableObject.DisposeUnmanagedResources(), ObservableObject.IsDisposed, ObservableObject.TryDisposing, ObservableObject.Disposed, ObservableObject.Disposing, ObservableObject.PropertyChanged

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects(object, LinkPropertyType)

Constructors

HydroForce()

Initializes a new instance of the class.

public HydroForce()

HydroForce(string)

Initializes a new instance of the class.

public HydroForce(string strName)

Parameters

strName string

Name of the string.

Properties

ActionBodies

Gets or sets the action body data.

public HydroForce.ActionBodyData[] ActionBodies { get; set; }

Property Value

HydroForce.ActionBodyData[]

HasLayerExplicitly

Gets a value indicating whether object has a layer explicitly.

protected override bool HasLayerExplicitly { get; }

Property Value

bool

Hide

Gets or sets a value indicating whether this instance is hide.

public bool Hide { get; set; }

Property Value

bool

Water

Gets or sets the water.

public IWater Water { get; set; }

Property Value

IWater

_Water

Gets or sets the water.

public Linker<iwater> _Water { get; set; }

Property Value

LinkerIWater&gt;

Methods

Draw(Canvas)

Draws the icon.

public virtual void Draw(Canvas canvas)

Parameters

canvas Canvas

The canvas has icon information.

GetCenterMarkerFromIConnectable(IConnectable)

Gets center marker from connectable entity

public static IMarker GetCenterMarkerFromIConnectable(IConnectable connectable)

Parameters

connectable IConnectable

The connectable entity

Returns

IMarker

GetMassFromIConnectable(IConnectable)

Gets mass from connectable entity

public static double GetMassFromIConnectable(IConnectable connectable)

Parameters

connectable IConnectable

The connectable entity

Returns

double

GetModelNavigatorInformationImpl(XmlDocument, XmlElement, bool)

Gets the object information for model navigator [implementation].

protected override bool GetModelNavigatorInformationImpl(XmlDocument xmlDom, XmlElement xmlEle, bool bHasChild)

Parameters

xmlDom XmlDocument

The XmlDocument for object.

xmlEle XmlElement

The XmlElement for object.

bHasChild bool

if set to true [has child].

Returns

bool

true if success; otherwise, false.

GetPatches(ActionBodyData, ref VectorBase[], ref uint[], ref TMatrix, ref double)

Gets Patches

public void GetPatches(HydroForce.ActionBodyData actionBodyData, ref VectorBase[] arPos, ref uint[] arConnectivity, ref TMatrix matT, ref double dBBVolume)

Parameters

actionBodyData HydroForce.ActionBodyData

The action body data

arPos VectorBase[]

The postition

arConnectivity uint[]

The connectivity

matT TMatrix

The transform matrix

dBBVolume double

The boundary box volume

GetPatches(Document, string, SurfaceType, int, ref VectorBase[], ref uint[], ref TMatrix, ref double, SetProgressDelegate)

Gets Patches

public static void GetPatches(Document document, string strBodyName, HydroForce.ActionBodyData.SurfaceType typeSurface, int nCoarseningFactor, ref VectorBase[] arPos, ref uint[] arConnectivity, ref TMatrix matT, ref double dBBVolume, HydroForce.SetProgressDelegate delegateProgress)

Parameters

document Document

The document

strBodyName string

The body name

typeSurface HydroForce.ActionBodyData.SurfaceType

The surface type

nCoarseningFactor int

The coarsening factor

arPos VectorBase[]

The postition

arConnectivity uint[]

The connectivity

matT TMatrix

The transform matrix

dBBVolume double

The boundary box volume

delegateProgress HydroForce.SetProgressDelegate

The progress delegate

GetVolumeFromIConnectable(IConnectable)

Gets volume from connectable entity

public static double GetVolumeFromIConnectable(IConnectable connectable)

Parameters

connectable IConnectable

The connectable entity

Returns

double

LinkRequestUpdate(object, LinkEventArgs)

Request for update the linked object.

protected override void LinkRequestUpdate(object objNotifier, LinkEventArgs arg)

Parameters

objNotifier object

The linked object.

arg LinkEventArgs

The instance containing the event data.

ReDraw()

Redraw.

public virtual void ReDraw()

Connect with Ansys